resqml2_0_1::ContinuousProperty Class Reference

#include <ContinuousProperty.h>

Inheritance diagram for resqml2_0_1::ContinuousProperty:

Public Member Functions
	ContinuousProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ContinuousProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, gsoap_resqml2_0_1::resqml20__ResqmlUom uom, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind)
	ContinuousProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, gsoap_resqml2_0_1::resqml20__ResqmlUom uom, eml2 ::PropertyKind *localPropKind)
	ContinuousProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, const std::string &nonStandardUom, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind)
	ContinuousProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, const std::string &nonStandardUom, eml2 ::PropertyKind *localPropKind)
	ContinuousProperty (gsoap_resqml2_0_1::_resqml20__ContinuousProperty *fromGsoap)
	~ContinuousProperty ()=default
gsoap_resqml2_0_1::resqml20__ResqmlUom	getUom () const final
std::string	getUomAsString () const final
double	getMinimumValue (unsigned int index=0) const final
double	getMaximumValue (unsigned int index=0) const final
void	setMinimumValue (double value, unsigned int index=0) const final
void	setMaximumValue (double value, unsigned int index=0) const final
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	getEnergisticsPropertyKind () const
bool	validatePropertyKindAssociation (eml2 ::PropertyKind *pk) final
bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) final
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

Detailed Description

Proxy class for a continuous property. Most common type of property used for storing rock or fluid attributes; all are represented as floating point values. So that the value range can be known before accessing all values, the min and max values of the range are also optionally stored. BUSINESS RULE: It also contains a unit of measure, which can be different from the unit of measure of its property type, but it must be convertible into this unit.

Constructor & Destructor Documentation

ContinuousProperty() [1/6]

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

inline

Only to be used in partial transfer context.

Parameters

[in]

partialObject

If non-nullptr, the partial object.

ContinuousProperty() [2/6]

resqml2_0_1::ContinuousProperty::ContinuousProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		gsoap_resqml2_0_1::resqml20__ResqmlUom	uom,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	energisticsPropertyKind )

Creates a continuous property which is of well known Energistics unit of measure and 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.
	uom	The property unit of measure taken from the standard Energistics units of measure catalog. Please check COMMON_NS::EnumStringMapper::getEnergisticsUnitOfMeasure in order to minimize the use of non standard unit of measure.
	energisticsPropertyKind	The property kind of these property values which must be defined in the standard Energistics property type dictionary.

ContinuousProperty() [3/6]

resqml2_0_1::ContinuousProperty::ContinuousProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		gsoap_resqml2_0_1::resqml20__ResqmlUom	uom,
		eml2 ::PropertyKind *	localPropKind )

Creates a continuous property which is of a well known unit of measure and a local property kind.

Exceptions

std::invalid_argument

If rep or localPropType 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.
	uom	The property unit of measure taken from the standard Energistics units of measure catalog. Please check COMMON_NS::EnumStringMapper::getEnergisticsUnitOfMeasure in order to minimize the use of non standard unit of measure.
[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.

ContinuousProperty() [4/6]

resqml2_0_1::ContinuousProperty::ContinuousProperty	(	resqml2 ::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::eml23__IndexableElement	attachmentKind,
		const std::string &	nonStandardUom,
		gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind	energisticsPropertyKind )

Creates a continuous property which is of a local unit of measure and a well known 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.
	nonStandardUom	The property unit of measure. Please check COMMON_NS::EnumStringMapper::getEnergisticsUnitOfMeasure in order to minimize the use of non standard unit of measure.
	energisticsPropertyKind	The property kind of these property values which must be defined in the standard Energistics property type dictionary.

ContinuousProperty() [5/6]

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

Creates a continuous property which is of local unit of measure and property kind.

Exceptions

std::invalid_argument

If rep or localPropType 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.
	nonStandardUom	The property unit of measure. Please check COMMON_NS::EnumStringMapper::getEnergisticsUnitOfMeasure in order to minimize the use of non standard unit of measure.
[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.

ContinuousProperty() [6/6]

resqml2_0_1::ContinuousProperty::ContinuousProperty ( gsoap_resqml2_0_1::_resqml20__ContinuousProperty * fromGsoap )

inline

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

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

~ContinuousProperty()

resqml2_0_1::ContinuousProperty::~ContinuousProperty ( )

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::ContinuousProperty::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.

getUom()

gsoap_resqml2_0_1::resqml20__ResqmlUom resqml2_0_1::ContinuousProperty::getUom ( ) const

final

Gets the unit of measure of the values of this property. If resqml20__ResqmlUom::resqml20__ResqmlUom::Euc is returned and if your instance is a 2.0.1 one, you should check if an extrametadata called "Uom" also exists. If so, it would mean that the property uses a non standard unit of measure. This is an official workaround for a known issue of Resqml 2.0.1.

Returns

The unit of measure of the values of this property.

getUomAsString()

std::string resqml2_0_1::ContinuousProperty::getUomAsString ( ) const

final

Gets the unit of measure of the values of this property as a string. If "Euc" is returned, you should check if an extrametadata called "Uom" also exists. If so, it would mean that the property uses a non standard uom. This is an official workaround for a known issue of Resqml 2.0.1.

Returns

The unit of measure of the values of this property as a string.

getXmlNamespace()

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

inlinefinal

Get the standard XML namespace for serializing this data object.

Member Data Documentation

XML_NS

const char* resqml2_0_1::ContinuousProperty::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/ContinuousProperty.h