Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::DiscreteProperty Class Referencefinal

#include <DiscreteProperty.h>

Inheritance diagram for resqml2_0_1::DiscreteProperty:
resqml2::DiscreteProperty resqml2::AbstractValuesProperty resqml2::AbstractProperty common::AbstractObject

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::resqml22__IndexableElement attachmentKind, gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind energisticsPropertyKind)
 
 DiscreteProperty (resqml2::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::resqml22__IndexableElement attachmentKind, eml2::PropertyKind *localPropKind)
 
 DiscreteProperty (gsoap_resqml2_0_1::_resqml20__DiscreteProperty *fromGsoap)
 
 ~DiscreteProperty ()=default
 
std::string pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName, int64_t nullValue, int64_t minimumValue, int64_t maximumValue) final
 
bool validatePropertyKindAssociation (eml2::PropertyKind *pk) final
 
bool validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) final
 
int64_t getNullValue (unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)()) const final
 Gets the null value in this discrete property. More...
 
bool hasMinimumValue (unsigned int index=0) const final
 Checks if a non vector property or a given value of a vector property has got a minimum value already computed (or set). More...
 
int64_t getMinimumValue (unsigned int index=0) const final
 Gets the minimum value of a non vector property or the minimum value of one given value of a vector property. This minimum value is read (it is not computed). More...
 
bool hasMaximumValue (unsigned int index=0) const final
 Checks if a non vector property or a given value of a vector property has got a maximum value already computed (or set). More...
 
int64_t getMaximumValue (unsigned int index=0) const final
 Gets the maximum value of a non vector property or the maximum value of one given value of a vector property. This maximum value is read (it is not computed). More...
 
void setMinimumValue (int64_t value, unsigned int index=0) const final
 Sets the minimum value of a non vector property or the minimum value of one given value of a vector property. More...
 
void setMaximumValue (int64_t value, unsigned int index=0) const
 Sets the maximum value of a non vector property or the maximum value of one given value of a vector property. More...
 
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getEnergisticsPropertyKind () const
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::DiscreteProperty
void pushBackLongHdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)
 Adds a 1d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
 
void pushBackShortHdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
 
void pushBackCharHdf5Array1dOfValues (const char *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, char nullValue, char minimumValue, char maximumValue)
 
void pushBackLongHdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)
 Adds a 2d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
 
void pushBackShortHdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
 
void pushBackUShortHdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue)
 
void pushBackCharHdf5Array2dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue, char minimumValue, char maximumValue)
 
void pushBackLongHdf5Array3dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)
 Adds a 3d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
 
void pushBackShortHdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
 
void pushBackUShortHdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue)
 
void pushBackCharHdf5Array3dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue, char minimumValue, char maximumValue)
 
void pushBackLongHdf5ArrayOfValues (const int64_t *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int64_t nullValue) final
 Adds an nd array of explicit long values to the property values. More...
 
void pushBackIntHdf5ArrayOfValues (const int *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int nullValue) final
 
void pushBackShortHdf5ArrayOfValues (const short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, short nullValue) final
 
void pushBackUShortHdf5ArrayOfValues (const unsigned short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, unsigned short nullValue) final
 
void pushBackCharHdf5ArrayOfValues (const char *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, char nullValue) final
 
void pushBackLongHdf5ArrayOfValues (const int64_t *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)
 Adds an nd array of explicit long values to the property values. More...
 
void pushBackIntHdf5ArrayOfValues (const int *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
 
void pushBackShortHdf5ArrayOfValues (const short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
 
void pushBackUShortHdf5ArrayOfValues (const unsigned short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue)
 
void pushBackCharHdf5ArrayOfValues (const char *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, char nullValue, char minimumValue, char maximumValue)
 
void pushBackLongHdf5ArrayOfValues (unsigned long long *numValues, unsigned int numArrayDimensions, int64_t *minimumValue, int64_t *maximumValue, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackLongHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t minimumValue, int64_t maximumValue, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfLongHdf5Array3dOfValues (int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, bool computeMinMax, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
void setValuesOfLongHdf5ArrayOfValues (int64_t *values, unsigned long long const *numValues, unsigned long long const *offsetValues, unsigned int numArrayDimensions, bool computeMinMax, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
virtual std::string getXmlTag () const final
 
void pushBackLongHdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 1d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackCharHdf5Array1dOfValues (const char *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, char nullValue)
 
void pushBackLongHdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 2d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUShortHdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackCharHdf5Array2dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
 
void pushBackLongHdf5Array3dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 3d array of explicit long values to the property values. More...
 
void pushBackLongHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackIntHdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUShortHdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackCharHdf5Array3dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
 
virtual std::string pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *hdfProxy, const std::string &dataset="", int64_t nullValue=(std::numeric_limits< int64_t >::max)())
 
virtual void pushBackLongHdf5ArrayOfValues (const int64_t *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds an nd array of explicit long values to the property values. More...
 
void pushBackLongHdf5ArrayOfValues (unsigned long long *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfLongHdf5Array3dOfValues (int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
- Public Member Functions inherited from resqml2::AbstractValuesProperty
virtual ~AbstractValuesProperty ()=default
 
unsigned int getPatchCount () const final
 
void pushBackFacet (gsoap_eml2_3::eml23__FacetKind facet, const std::string &facetValue)
 
unsigned int getFacetCount () const
 
gsoap_eml2_3::eml23__FacetKind getFacetKind (unsigned int index) const
 
std::string getFacetValue (unsigned int index) const
 
void pushBackLongHdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 1d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackCharHdf5Array1dOfValues (const char *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, char nullValue)
 
void pushBackLongHdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 2d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUShortHdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackCharHdf5Array2dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
 
void pushBackLongHdf5Array3dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 3d array of explicit long values to the property values. More...
 
void pushBackIntHdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackShortHdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUShortHdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackCharHdf5Array3dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
 
virtual std::string pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *hdfProxy, const std::string &dataset="", int64_t nullValue=(std::numeric_limits< int64_t >::max)())
 
int64_t getLongValuesOfPatch (unsigned int patchIndex, int64_t *values) const
 
int64_t getNullValueOfPatch (unsigned int patchIndex) const
 
uint64_t getULongValuesOfPatch (unsigned int patchIndex, uint64_t *values) const
 
int getIntValuesOfPatch (unsigned int patchIndex, int *values) const
 
unsigned int getUIntValuesOfPatch (unsigned int patchIndex, unsigned int *values) const
 
short getShortValuesOfPatch (unsigned int patchIndex, short *values) const
 
unsigned short getUShortValuesOfPatch (unsigned int patchIndex, unsigned short *values) const
 
char getCharValuesOfPatch (unsigned int patchIndex, char *values) const
 
unsigned char getUCharValuesOfPatch (unsigned int patchIndex, unsigned char *values) const
 
void pushBackLongHdf5ArrayOfValues (unsigned long long *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackLongHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfLongHdf5Array3dOfValues (int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
void setValuesOfLongHdf5ArrayOfValues (int64_t *values, unsigned long long const *numValues, unsigned long long const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
void getLongValuesOfPatch (unsigned int patchIndex, int64_t *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getLongValuesOf3dPatch (unsigned int patchIndex, int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
 
int getIntValuesOfPatch (unsigned int patchIndex, int *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getIntValuesOf3dPatch (unsigned int patchIndex, int *values, unsigned int valueCountInFastestDim, unsigned int valueCountInMiddleDim, unsigned int valueCountInSlowestDim, unsigned int offsetInFastestDim, unsigned int offsetInMiddleDim, unsigned int offsetInSlowestDim) const
 
void pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds a 1d array of explicit double values to the property values. More...
 
void pushBackDoubleHdf5Array2dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds a 2d array of explicit double values to the property values. More...
 
void pushBackDoubleHdf5Array3dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds a 3d array of explicit double values to the property values. More...
 
void pushBackDoubleHdf5ArrayOfValues (double const *values, unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds an nd array of explicit double values to the property values. More...
 
void pushBackFloatHdf5Array1dOfValues (const float *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5Array2dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5Array3dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5ArrayOfValues (float const *values, unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
 
virtual std::string pushBackRefToExistingFloatingPointDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName="")
 
void getDoubleValuesOfPatch (unsigned int patchIndex, double *values) const
 
void getFloatValuesOfPatch (unsigned int patchIndex, float *values) const
 
void pushBackFloatHdf5ArrayOfValues (unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfFloatHdf5Array3dOfValues (float const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
void setValuesOfFloatHdf5ArrayOfValues (float const *values, unsigned long long const *numValues, unsigned long long const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
 
void getFloatValuesOfPatch (unsigned int patchIndex, float *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getFloatValuesOf3dPatch (unsigned int patchIndex, float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
 
- Public Member Functions inherited from resqml2::AbstractProperty
virtual ~AbstractProperty ()=default
 
void setRepresentation (AbstractRepresentation *rep)
 
common::DataObjectReference getRepresentationDor () const
 
AbstractRepresentationgetRepresentation () const
 
unsigned int getElementCountPerValue () const
 
gsoap_eml2_3::resqml22__IndexableElement getAttachmentKind () const
 
common::AbstractObject::hdfDatatypeEnum getValuesHdfDatatype () const
 
unsigned int getValuesCountOfPatch (unsigned int patchIndex) const
 
unsigned int getValuesCountOfDimensionOfPatch (unsigned int dimIndex, unsigned int patchIndex) const
 
unsigned int getDimensionsCountOfPatch (unsigned int patchIndex) const
 
std::vector< resqml2::PropertySet * > getPropertySets () const
 
unsigned int getPropertySetCount () const
 
resqml2::PropertySetgetPropertySet (unsigned int index) const
 
void setLocalCrs (class AbstractLocal3dCrs *crs)
 
class AbstractLocal3dCrsgetLocalCrs () const
 
common::DataObjectReference getLocalCrsDor () const
 
bool hasRealizationIndices () const
 
std::vector< unsigned int > getRealizationIndices () const
 
void setRealizationIndices (uint64_t startRealizationIndex, uint64_t countRealizationIndices)
 
void setRealizationIndices (const std::vector< unsigned int > &realizationIndices, eml2::AbstractHdfProxy *hdfProxy=nullptr)
 Sets the realization indices of this property. More...
 
void setTimeSeries (eml2::TimeSeries *ts)
 
eml2::TimeSeriesgetTimeSeries () const
 
common::DataObjectReference getTimeSeriesDor () const
 
void setTimeIndices (uint64_t startTimeIndex, uint64_t countTimeIndices, eml2::TimeSeries *ts, bool useInterval=false)
 Sets the timestamps of this property by means of an index in a time series. More...
 
unsigned int getTimeIndexStart () const
 
unsigned int getTimeIndicesCount () const
 
bool useInterval () const
 
bool isAssociatedToOneStandardEnergisticsPropertyKind () const
 
std::string getPropertyKindDescription () const
 
std::string getPropertyKindAsString () const
 
std::string getPropertyKindParentAsString () const
 
void setPropertyKind (eml2::PropertyKind *propKind)
 
common::DataObjectReference getPropertyKindDor () const
 
eml2::PropertyKindgetPropertyKind () const
 
bool validate ()
 
- Public Member Functions inherited from common::AbstractObject
bool isPartial () const
 
virtual bool isTopLevelElement () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
tm getCreationAsTimeStructure () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
tm getLastUpdateAsTimeStructure () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
std::string getVersion () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (time_t creation)
 
void setCreation (const tm &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (time_t lastUpdate)
 
void setLastUpdate (const tm &lastUpdate)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setVersion (const std::string &version)
 
void setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
 
void setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
gsoap_eml2_1::eml21__AbstractObject * getEml21GsoapProxy () const
 
gsoap_eml2_2::eml22__AbstractObject * getEml22GsoapProxy () const
 
void setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)
 
gsoap_eml2_3::eml23__AbstractObject * getEml23GsoapProxy () const
 
void setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * newResqmlReference () const
 
gsoap_eml2_1::eml21__DataObjectReference * newEmlReference () const
 
gsoap_eml2_2::eml22__DataObjectReference * newEml22Reference () const
 
gsoap_eml2_3::eml23__DataObjectReference * newEml23Reference () const
 
gsoap_resqml2_0_1::resqml20__ContactElementReference * newContactElementReference2_0_1 () const
 
gsoap_eml2_3::resqml22__ContactElement * newContactElementReference2_2 () const
 
common::DataObjectRepositorygetRepository () const
 
virtual std::string getXmlNamespaceVersion () const
 
virtual std::string getContentType () const
 
virtual std::string getQualifiedType () const
 
virtual std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (unsigned int index) const
 
std::string getAliasTitleAtIndex (unsigned int index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
unsigned int getActivityCount () const
 
eml2::ActivitygetActivity (unsigned int index) const
 
void pushBackExtraMetadata (const std::string &key, const std::string &value)
 
std::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::vector< std::string > getExtraMetadata (const std::string &key) const
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (unsigned int index) const
 
std::string getExtraMetadataStringValueAtIndex (unsigned int index) const
 

Static Public Attributes

static const char * XML_NS
 
- Static Public Attributes inherited from resqml2::DiscreteProperty
static const char * XML_TAG
 

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum  hdfDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 ,
  ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 ,
  USHORT = 8 , CHAR = 9 , UCHAR = 10
}
 
- Static Public Member Functions inherited from common::AbstractObject
static void setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)
 

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/4]

resqml2_0_1::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/4]

resqml2_0_1::DiscreteProperty::DiscreteProperty ( resqml2::AbstractRepresentation rep,
const std::string &  guid,
const std::string &  title,
unsigned int  dimension,
gsoap_eml2_3::resqml22__IndexableElement  attachmentKind,
gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  energisticsPropertyKind 
)

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

Exceptions
std::invalid_argumentIf rep 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.
energisticsPropertyKindThe property kind of these property values which must be defined in the standard Energistics property type dictionary.

◆ DiscreteProperty() [3/4]

resqml2_0_1::DiscreteProperty::DiscreteProperty ( resqml2::AbstractRepresentation rep,
const std::string &  guid,
const std::string &  title,
unsigned int  dimension,
gsoap_eml2_3::resqml22__IndexableElement  attachmentKind,
eml2::PropertyKind localPropKind 
)

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

Exceptions
std::invalid_argumentIf or localPropKind 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.
[in]localPropKindThe property kind of these property values which must be defined in the EPC document as a local property kind. It cannot be null.

◆ DiscreteProperty() [4/4]

resqml2_0_1::DiscreteProperty::DiscreteProperty ( gsoap_resqml2_0_1::_resqml20__DiscreteProperty *  fromGsoap)
inline

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

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

◆ ~DiscreteProperty()

resqml2_0_1::DiscreteProperty::~DiscreteProperty ( )
virtualdefault

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

Reimplemented from resqml2::DiscreteProperty.

Member Function Documentation

◆ getEnergisticsPropertyKind()

gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind resqml2_0_1::DiscreteProperty::getEnergisticsPropertyKind ( ) const

Gets the Energistics property kind which is associated to this intance

Exceptions
std::invalid_argumentIf the property kind of this property is not an Energistics one.
Returns
The Energistics property kind.

◆ getMaximumValue()

int64_t resqml2_0_1::DiscreteProperty::getMaximumValue ( unsigned int  index = 0) const
finalvirtual

Gets the maximum value of a non vector property or the maximum value of one given value of a vector property. This maximum value is read (it is not computed).

Exceptions
std::logic_errorIf this property has no maximum value.
Parameters
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we look for the maximum value (vector property case).
Returns
The maximum value of the non vector property or the maximum value at position index of the vector value or NaN if index is out of range (strictly greater than 0 for a non vector property or greater than the vector size for a vector property).

Implements resqml2::DiscreteProperty.

◆ getMinimumValue()

int64_t resqml2_0_1::DiscreteProperty::getMinimumValue ( unsigned int  index = 0) const
finalvirtual

Gets the minimum value of a non vector property or the minimum value of one given value of a vector property. This minimum value is read (it is not computed).

Exceptions
std::logic_errorIf this property has no minimum value.
Parameters
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we look for the minimum value (vector property case).
Returns
The minimum value of the non vector property or the minimum value at position index of the vector value or NaN if index is out of range (strictly greater than 0 for a non vector property or greater than the vector size for a vector property).

Implements resqml2::DiscreteProperty.

◆ getNullValue()

int64_t resqml2_0_1::DiscreteProperty::getNullValue ( unsigned int  patchIndex = (std::numeric_limits< unsigned int >::max)()) const
finalvirtual

Gets the null value in this discrete property.

Parameters
patchIndex(Optional) Zero-based index of the patch for which we want to get the null value.
Returns
The null value of this discrete property if present otherwise the maximum int 64 bits value.

Implements resqml2::DiscreteProperty.

◆ getXmlNamespace()

std::string resqml2_0_1::DiscreteProperty::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ hasMaximumValue()

bool resqml2_0_1::DiscreteProperty::hasMaximumValue ( unsigned int  index = 0) const
finalvirtual

Checks if a non vector property or a given value of a vector property has got a maximum value already computed (or set).

Parameters
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we want to know if a maximum value exists (vector property case).
Returns
True if there exists a maximum value, false if not.

Implements resqml2::DiscreteProperty.

◆ hasMinimumValue()

bool resqml2_0_1::DiscreteProperty::hasMinimumValue ( unsigned int  index = 0) const
finalvirtual

Checks if a non vector property or a given value of a vector property has got a minimum value already computed (or set).

Parameters
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we want to know if a minimum value exists (vector property case).
Returns
True if there exists a minimum value, false if not.

Implements resqml2::DiscreteProperty.

◆ pushBackRefToExistingIntegerDataset()

std::string resqml2_0_1::DiscreteProperty::pushBackRefToExistingIntegerDataset ( eml2::AbstractHdfProxy proxy,
const std::string &  datasetName,
int64_t  nullValue,
int64_t  minimumValue,
int64_t  maximumValue 
)
finalvirtual

Pushes back a reference to an existing (or a "to exist") HDF dataset in a particular HDF proxy. The reason can be that the index 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_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
[in]proxyThe HDF5 proxy where the values are already or will be stored. If nullptr, then a default HDF proxy must be defined in the repository.
datasetNameThe 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() + "/values_patch" + patch->RepresentationPatchIndex
nullValueThe null value which has been chosen in the referenced HDF dataset.
minimumValueThe minimum value of the values in the HDF5 dataset.
maximumValueThe maximum value of the values in the HDF5 dataset.
Returns
The name of the referenced HDF5 dataset.

Implements resqml2::DiscreteProperty.

◆ setMaximumValue()

void resqml2_0_1::DiscreteProperty::setMaximumValue ( int64_t  value,
unsigned int  index = 0 
) const
virtual

Sets the maximum value of a non vector property or the maximum value of one given value of a vector property.

Parameters
valueThe maximum value to set.
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we want to set the maximum value (vector property case).

Implements resqml2::DiscreteProperty.

◆ setMinimumValue()

void resqml2_0_1::DiscreteProperty::setMinimumValue ( int64_t  value,
unsigned int  index = 0 
) const
finalvirtual

Sets the minimum value of a non vector property or the minimum value of one given value of a vector property.

Parameters
valueThe minimum value to set.
index(Optional) 0 (default value, corresponding to the non vector property case) or zero-based index of the vector value for which we want to set the minimum value (vector property case).

Implements resqml2::DiscreteProperty.

◆ validatePropertyKindAssociation() [1/2]

bool resqml2_0_1::DiscreteProperty::validatePropertyKindAssociation ( eml2::PropertyKind pk)
finalvirtual

Checks if it is allowed to associate a given property kind to this property.

Parameters
[in]pkThe local property kind to check.
Returns
True if it is allowed, false if it is not.

Implements resqml2::AbstractProperty.

◆ validatePropertyKindAssociation() [2/2]

bool resqml2_0_1::DiscreteProperty::validatePropertyKindAssociation ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  pk)
finalvirtual

Checks if it is allowed to associate a given standard Energistics property kind to this property.

Parameters
pkThe standard Energistics property kind to check.
Returns
True if it is allowed, false if it is not.

Implements resqml2::AbstractProperty.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::DiscreteProperty::XML_NS
static

The standard XML namespace for serializing this data object.


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