Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2_2::ContinuousProperty Class Referencefinal

#include <ContinuousProperty.h>

Inheritance diagram for resqml2_2::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, eml2 ::PropertyKind *propKind)
 
 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 *propKind)
 
 ContinuousProperty (gsoap_eml2_3::_resqml22__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
 
bool validatePropertyKindAssociation (eml2 ::PropertyKind *) final
 
bool validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) 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/4]

resqml2_2::ContinuousProperty::ContinuousProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context.

Parameters
[in]partialObjectIf non-nullptr, the partial object.

◆ ContinuousProperty() [2/4]

resqml2_2::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 * propKind )

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

Exceptions
std::invalid_argumentIf rep or propKind is null. If dimension is zero.
Parameters
[in]repThe representation on which this property is attached to. It cannot be null.
guidThe guid to set to the property. If empty then a new guid will be generated.
titleThe title to set to the property. If empty then "unknown" title will be set.
dimensionThe dimension of each value of this property. Dimension is 1 for a scalar property.
attachmentKindThe topological element on which the property values are attached to.
uomThe 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]propKindThe property kind of these property values. It cannot be null.

◆ ContinuousProperty() [3/4]

resqml2_2::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 * propKind )

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

Exceptions
std::invalid_argumentIf rep or propKind is null.
Parameters
[in]repThe representation on which this property is attached to. It cannot be null.
guidThe guid to set to the property. If empty then a new guid will be generated.
titleThe title to set to the property. If empty then "unknown" title will be set.
dimensionThe dimension of each value of this property. Dimension is 1 for a scalar property.
attachmentKindThe topological element on which the property values are attached to.
nonStandardUomThe property unit of measure. Please check COMMON_NS::EnumStringMapper::getEnergisticsUnitOfMeasure in order to minimize the use of non standard unit of measure.
[in]propKindThe property kind of these property values. It cannot be null.

◆ ContinuousProperty() [4/4]

resqml2_2::ContinuousProperty::ContinuousProperty ( gsoap_eml2_3::_resqml22__ContinuousProperty * fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~ContinuousProperty()

resqml2_2::ContinuousProperty::~ContinuousProperty ( )
default

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

Member Function Documentation

◆ getXmlNamespace()

std::string resqml2_2::ContinuousProperty::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::ContinuousProperty::XML_NS
static

The standard XML namespace for serializing this data object.


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