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::DiscreteProperty Class Referencefinal

#include <DiscreteProperty.h>

Inheritance diagram for resqml2_2::DiscreteProperty:

Public Member Functions

 DiscreteProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 DiscreteProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, eml2 ::PropertyKind *propKind)
 
 DiscreteProperty (gsoap_eml2_3::_resqml22__DiscreteProperty *fromGsoap)
 
 ~DiscreteProperty ()=default
 
std::string pushBackRefToExistingIntegerDataset (eml2 ::AbstractHdfProxy *proxy, const std::string &datasetName, int64_t nullValue, int64_t minimumValue, int64_t maximumValue) final
 
int64_t getNullValue (uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)()) const final
 
bool hasMinimumValue (uint64_t index=0) const final
 
int64_t getMinimumValue (uint64_t index=0) const final
 
bool hasMaximumValue (uint64_t index=0) const final
 
int64_t getMaximumValue (uint64_t index=0) const final
 
void setMinimumValue (int64_t value, uint64_t index=0) const final
 
void setMaximumValue (int64_t value, uint64_t 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 discrete property. Such property contains discrete integer values; typically used to store any type of index. So that the value range can be known before accessing all values, it also optionally stores the minimum and maximum value in the range.

Constructor & Destructor Documentation

◆ DiscreteProperty() [1/3]

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

Only to be used in partial transfer context.

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

◆ DiscreteProperty() [2/3]

resqml2_2::DiscreteProperty::DiscreteProperty ( resqml2 ::AbstractRepresentation * rep,
const std::string & guid,
const std::string & title,
unsigned int dimension,
gsoap_eml2_3::eml23__IndexableElement attachmentKind,
eml2 ::PropertyKind * propKind )

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

Exceptions
std::invalid_argumentIf or localPropKind 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.
[in]propKindThe property kind of these property values. It cannot be null.

◆ DiscreteProperty() [3/3]

resqml2_2::DiscreteProperty::DiscreteProperty ( gsoap_eml2_3::_resqml22__DiscreteProperty * fromGsoap)
inline

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

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

◆ ~DiscreteProperty()

resqml2_2::DiscreteProperty::~DiscreteProperty ( )
default

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

Member Function Documentation

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::DiscreteProperty::XML_NS
static

The standard XML namespace for serializing this data object.


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