resqml2_0_1::PointsProperty Class Reference

Proxy class for an points property. More...

#include <PointsProperty.h>

Inheritance diagram for resqml2_0_1::PointsProperty:

Public Member Functions
	PointsProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	PointsProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, resqml2 ::AbstractLocal3dCrs *localCrs, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind=gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind::length)
	PointsProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, resqml2 ::AbstractLocal3dCrs *localCrs, eml2 ::PropertyKind *localPropKind)
	PointsProperty (gsoap_resqml2_0_1::_resqml20__PointsProperty *fromGsoap)
	~PointsProperty ()=default
uint64_t	getPatchCount () const final
std::string	pushBackRefToExistingDataset (eml2 ::AbstractHdfProxy *proxy, const std::string &datasetName="") final
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	getEnergisticsPropertyKind () const
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

Detailed Description

Proxy class for an points property.

Constructor & Destructor Documentation

PointsProperty() [1/4]

resqml2_0_1::PointsProperty::PointsProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out]

partialObject

If non-null, the partial object.

PointsProperty() [2/4]

resqml2_0_1::PointsProperty::PointsProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		resqml2 ::AbstractLocal3dCrs *	localCrs,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	energisticsPropertyKind = gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind::length )

Creates a discrete property which is of a well known Energistics property kind.

Exceptions

std::invalid_argument

If rep is null.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
	localCrs	The local CRS where the points are defined.
	energisticsPropertyKind	The property kind of these property values which must be defined in the standard Energistics property type dictionary. Defatul is a length kind

PointsProperty() [3/4]

resqml2_0_1::PointsProperty::PointsProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		resqml2 ::AbstractLocal3dCrs *	localCrs,
		eml2 ::PropertyKind *	localPropKind )

Creates a discrete property which is of a local property kind.

Exceptions

std::invalid_argument

If or localPropKind is null.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
	localCrs	The local CRS where the points are defined.
[in]	localPropKind	The property kind of these property values which must be defined in the EPC document as a local property kind. It cannot be null.

PointsProperty() [4/4]

resqml2_0_1::PointsProperty::PointsProperty ( gsoap_resqml2_0_1::_resqml20__PointsProperty * fromGsoap )

inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~PointsProperty()

resqml2_0_1::PointsProperty::~PointsProperty ( )

default

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

getEnergisticsPropertyKind()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::PointsProperty::getEnergisticsPropertyKind

(

)

const

Gets the Energistics property kind which is associated to this intance

Exceptions

std::invalid_argument

If the property kind of this property is not an Energistics one.

Returns

The Energistics property kind.

getPatchCount()

uint64_t resqml2_0_1::PointsProperty::getPatchCount ( ) const

final

Gets the number of patches in this values property. It should be the same count as the patch count of the associated representation.

Exceptions

std::out_of_range

If the patch count is strictly greater than unsigned int max value.

Returns

The patch count.

getXmlNamespace()

std::string resqml2_0_1::PointsProperty::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

pushBackRefToExistingDataset()

std::string resqml2_0_1::PointsProperty::pushBackRefToExistingDataset ( eml2 ::AbstractHdfProxy * proxy, const std::string & datasetName = "" )

final

Pushes back a reference to an existing (or a "to exist") HDF dataset in a particular HDF proxy. The reason can be that the values already exist in an external file (only HDF5 for now) or that the writing of the values in the external file is differed in time.

Exceptions

std::invalid_argument

If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

[in]	proxy	The HDF5 proxy where the values are already or will be stored. If nullptr, then a default HDF proxy must be defined in the repository.
	datasetName	(Optional) The HDF5 dataset name where the values are stored. If empty, the dataset will be named the same as the dataset naming convention of fesapi : getHdfGroup() + "/points_patch" + patchIndex

Returns

The name of the referenced HDF5 dataset.

Member Data Documentation

XML_NS

const char* resqml2_0_1::PointsProperty::XML_NS

static

The standard XML namespace for serializing this data object.

---

The documentation for this class was generated from the following file:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2_0_1/PointsProperty.h