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::ContinuousProperty Class Referenceabstract

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. More...

#include <ContinuousProperty.h>

Inheritance diagram for resqml2::ContinuousProperty:
resqml2::AbstractValuesProperty resqml2::AbstractProperty

Public Member Functions

virtual ~ContinuousProperty ()=default
 
std::string pushBackRefToExistingIntegerDataset (eml2 ::AbstractHdfProxy *, const std::string &, int64_t) final
 
virtual gsoap_resqml2_0_1::resqml20__ResqmlUom getUom () const =0
 
virtual std::string getUomAsString () const =0
 
void pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, double minimumValue, double maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds a 1d array of explicit double values to the property values.
 
void pushBackDoubleHdf5Array2dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, double minimumValue, double maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds a 2d array of explicit double values to the property values.
 
void pushBackDoubleHdf5Array3dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, double minimumValue, double maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds a 3d array of explicit double values to the property values.
 
void pushBackDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, unsigned int numArrayDimensions, double *minimumValue, double *maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds an nd array of explicit double values to the property values.
 
void pushBackFloatHdf5Array1dOfValues (const float *values, uint64_t valueCount, float minimumValue, float maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5Array2dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, float minimumValue, float maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5Array3dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, float minimumValue, float maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackFloatHdf5ArrayOfValues (float const *values, uint64_t const *numValues, unsigned int numArrayDimensions, float *minimumValue, float *maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
virtual double getMinimumValue (unsigned int index=0) const =0
 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).
 
virtual double getMaximumValue (unsigned int index=0) const =0
 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).
 
virtual void setMinimumValue (double value, unsigned int index=0) const =0
 Sets the minimum value of a non vector property or the minimum value of one given value of a vector property.
 
virtual void setMaximumValue (double value, unsigned int index=0) const =0
 Sets the maximum value of a non vector property or the maximum value of one given value of a vector property.
 
void pushBackHdf5ArrayOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t const *numValues, unsigned int numArrayDimensions, double *minimumValue, double *maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array1dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCount, double minimumValue, double maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array2dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, double minimumValue, double maximumValue, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array3dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, double minimumValue, double maximumValue, 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, bool computeMinMax, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array3dOfValues (double const *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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5ArrayOfValues (float const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, bool computeMinMax, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, bool computeMinMax, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
virtual std::string getXmlTag () const final
 
void pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds a 1d array of explicit double values to the property values.
 
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.
 
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.
 
void pushBackDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds an nd array of explicit double values to the property values.
 
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, uint64_t const *numValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5ArrayOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t const *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array1dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCount, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array2dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array3dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), 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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array3dOfValues (double const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5ArrayOfValues (float const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
- Public Member Functions inherited from resqml2::AbstractValuesProperty
virtual ~AbstractValuesProperty ()=default
 
uint64_t getPatchCount () const final
 
common::AbstractObject::numericalDatatypeEnum getValuesHdfDatatype () const final
 
uint64_t getValuesCountOfDimensionOfPatch (uint64_t dimIndex, uint64_t patchIndex) const final
 
uint64_t getDimensionsCountOfPatch (uint64_t patchIndex) const final
 
void pushBackFacet (gsoap_eml2_3::eml23__FacetKind facet, const std::string &facetValue)
 
uint64_t getFacetCount () const
 
gsoap_eml2_3::eml23__FacetKind getFacetKind (uint64_t index) const
 
std::string getFacetValue (uint64_t index) const
 
void pushBackIntegerConstantArrayOfValues (int64_t value, uint64_t valueCount)
 Adds an array constant integer values to the property values.
 
void pushBackInt64Hdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 1d array of explicit int values to the property values.
 
void pushBackInt32Hdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackInt8Hdf5Array1dOfValues (const int8_t *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue)
 
void pushBackInt64Hdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 2d array of explicit int values to the property values.
 
void pushBackInt32Hdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUInt16Hdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackInt8Hdf5Array2dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue)
 
void pushBackInt64Hdf5Array3dOfValues (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 int values to the property values.
 
void pushBackInt32Hdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUInt16Hdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackInt8Hdf5Array3dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue)
 
virtual void pushBackInt64Hdf5ArrayOfValues (const int64_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds an nd array of explicit int values to the property values.
 
virtual void pushBackInt32Hdf5ArrayOfValues (const int *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int nullValue)
 
virtual void pushBackInt16Hdf5ArrayOfValues (const short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, short nullValue)
 
virtual void pushBackUInt16Hdf5ArrayOfValues (const unsigned short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue)
 
virtual void pushBackInt8Hdf5ArrayOfValues (const int8_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue)
 
bool hasConstantValues (uint64_t patchIndex) const
 
int64_t getInt64ConstantValuesOfPatch (uint64_t patchIndex) const
 
double getDoubleConstantValuesOfPatch (uint64_t patchIndex) const
 
int64_t getInt64ValuesOfPatch (uint64_t patchIndex, int64_t *values) const
 
int64_t getNullValueOfPatch (uint64_t patchIndex) const
 
int32_t getInt32ValuesOfPatch (uint64_t patchIndex, int32_t *values) const
 
uint32_t getUInt32ValuesOfPatch (uint64_t patchIndex, uint32_t *values) const
 
int16_t getInt16ValuesOfPatch (uint64_t patchIndex, int16_t *values) const
 
uint16_t getUInt16ValuesOfPatch (uint64_t patchIndex, uint16_t *values) const
 
int8_t getInt8ValuesOfPatch (uint64_t patchIndex, int8_t *values) const
 
uint8_t getUInt8ValuesOfPatch (uint64_t patchIndex, uint8_t *values) const
 
void pushBackHdf5ArrayOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t const *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array1dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCount, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array2dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array3dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfInt64Hdf5ArrayOfValues (int64_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5ArrayOfValues (uint64_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5ArrayOfValues (int32_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5ArrayOfValues (uint32_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5ArrayOfValues (int16_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5ArrayOfValues (uint16_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5ArrayOfValues (int8_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5ArrayOfValues (uint8_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5ArrayOfValues (float const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array1dOfValues (int64_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array1dOfValues (uint64_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array1dOfValues (int32_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array1dOfValues (uint32_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array1dOfValues (int16_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array1dOfValues (uint16_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array1dOfValues (int8_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array1dOfValues (uint8_t const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array1dOfValues (double const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5Array1dOfValues (float const *values, uint64_t valueCount, uint64_t offset, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array2dOfValues (int64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array2dOfValues (uint64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array2dOfValues (int32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array2dOfValues (uint32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array2dOfValues (int16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array2dOfValues (uint16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array2dOfValues (int8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array2dOfValues (uint8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array2dOfValues (double const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5Array2dOfValues (float const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array3dOfValues (int64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array3dOfValues (uint64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array3dOfValues (int32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array3dOfValues (uint32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array3dOfValues (int16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array3dOfValues (uint16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array3dOfValues (int8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array3dOfValues (uint8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array3dOfValues (double const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void getInt64ValuesOfPatch (uint64_t patchIndex, int64_t *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getInt64ValuesOf3dPatch (uint64_t patchIndex, int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
 
int32_t getIntValuesOfPatch (uint64_t patchIndex, int32_t *values, const uint64_t *numValuesInEachDimension, const uint64_t *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getIntValuesOf3dPatch (uint64_t patchIndex, int32_t *values, unsigned int valueCountInFastestDim, unsigned int valueCountInMiddleDim, unsigned int valueCountInSlowestDim, unsigned int offsetInFastestDim, unsigned int offsetInMiddleDim, unsigned int offsetInSlowestDim) const
 
void pushBackFloatingPointConstantArrayOfValues (double value, uint64_t valueCount)
 Adds an array constant flaoting point values to the property values.
 
void pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds a 1d array of explicit double values to the property values.
 
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.
 
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.
 
void pushBackDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr)
 Adds an nd array of explicit double values to the property values.
 
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, uint64_t const *numValues, unsigned int numArrayDimensions, eml2 ::AbstractHdfProxy *proxy=nullptr)
 
virtual std::string pushBackRefToExistingFloatingPointDataset (eml2 ::AbstractHdfProxy *proxy, const std::string &datasetName="")
 
void getDoubleValuesOfPatch (uint64_t patchIndex, double *values) const
 
void getFloatValuesOfPatch (uint64_t patchIndex, float *values) const
 
void getFloatValuesOfPatch (uint64_t patchIndex, float *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getFloatValuesOf3dPatch (uint64_t 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::eml23__IndexableElement getAttachmentKind () const
 
uint64_t getValuesCountOfPatch (unsigned int patchIndex) const
 
std::vector< resqml2_0_1 ::PropertySet * > getPropertySets () const
 
uint64_t getPropertySetCount () const
 
resqml2_0_1::PropertySetgetPropertySet (uint64_t 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 (int64_t startRealizationIndex, int64_t countRealizationIndices)
 
void setRealizationIndices (const std::vector< unsigned int > &realizationIndices, eml2 ::AbstractHdfProxy *hdfProxy=nullptr)
 Sets the realization indices of this property.
 
void setTimeSeries (eml2 ::TimeSeries *ts)
 
void setSingleTimestamp (time_t timestamp, LONG64 yearOffset=0)
 
time_t getSingleTimestamp () const
 
eml2::TimeSeriesgetTimeSeries () const
 
common::DataObjectReference getTimeSeriesDor () 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
 
virtual bool validatePropertyKindAssociation (eml2 ::PropertyKind *pk)=0
 
virtual bool validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk)=0
 
bool validate ()
 

Static Public Attributes

static const char * XML_TAG
 

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()

virtual resqml2::ContinuousProperty::~ContinuousProperty ( )
virtualdefault

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

Member Function Documentation

◆ getMaximumValue()

virtual double resqml2::ContinuousProperty::getMaximumValue ( unsigned int index = 0) const
pure virtual

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).

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).

◆ getMinimumValue()

virtual double resqml2::ContinuousProperty::getMinimumValue ( unsigned int index = 0) const
pure virtual

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).

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).

◆ getUom()

virtual gsoap_resqml2_0_1::resqml20__ResqmlUom resqml2::ContinuousProperty::getUom ( ) const
pure virtual

Gets the unit of measure of the values of this property. If resqml20__ResqmlUom::resqml20__ResqmlUom::Euc is returned, you should check if getUomAsString() gives you another result: it would be that the writer would have used a non standard unit of measure.

Returns
The unit of measure of the values of this property.

◆ getUomAsString()

virtual std::string resqml2::ContinuousProperty::getUomAsString ( ) const
pure virtual

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

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

◆ pushBackDoubleHdf5Array1dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackDoubleHdf5Array1dOfValues ( const double * values,
uint64_t valueCount,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 1d array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountThe number of values to write.
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5Array1dOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackDoubleHdf5Array1dOfValues ( const double * values,
uint64_t valueCount,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 1d array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountThe number of values to write.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5Array2dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackDoubleHdf5Array2dOfValues ( const double * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInSlowestDim,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 2d array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5Array2dOfValues() [2/2]

void resqml2::AbstractValuesProperty::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.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5Array3dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackDoubleHdf5Array3dOfValues ( const double * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
uint64_t valueCountInSlowestDim,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 3d array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5Array3dOfValues() [2/2]

void resqml2::AbstractValuesProperty::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.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackDoubleHdf5ArrayOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackDoubleHdf5ArrayOfValues ( double const * values,
uint64_t const * numValues,
unsigned int numArrayDimensions,
double * minimumValue,
double * maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds an nd array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf minimumValue == nullptr and maximumValue != nullptr .
std::invalid_argumentIf minimumValue != nullptr and maximumValue == nullptr .
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numArrayDimensionsThe number of dimensions of the array to write.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.
[in]minimumValueThe minimum value (or value vector) of the values to add. If nullptr is provided for both minimumValue and maximumValue then both minimum and maximum values will be computed from the values.
[in]maximumValueThe maximum value (or value vector) of the values to add. If @ nullptr is provided for both maximumValue and minimumValue then both minimum and maximum values will be computed from the values.

◆ pushBackDoubleHdf5ArrayOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackDoubleHdf5ArrayOfValues ( double const * values,
uint64_t const * numValues,
unsigned int numArrayDimensions,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds an nd array of explicit double values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numArrayDimensionsThe number of dimensions of the array to write.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array1dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array1dOfValues ( const float * values,
uint64_t valueCount,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 1d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountThe number of values to write.
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array1dOfValues() [2/2]

void resqml2::ContinuousProperty::pushBackFloatHdf5Array1dOfValues ( const float * values,
uint64_t valueCount,
float minimumValue,
float maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 1d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountThe number of values to write.
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array2dOfValues ( const float * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInSlowestDim,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 2d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array2dOfValues() [2/2]

void resqml2::ContinuousProperty::pushBackFloatHdf5Array2dOfValues ( const float * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInSlowestDim,
float minimumValue,
float maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 2d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array3dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array3dOfValues ( const float * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
uint64_t valueCountInSlowestDim,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 3d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5Array3dOfValues() [2/2]

void resqml2::ContinuousProperty::pushBackFloatHdf5Array3dOfValues ( const float * values,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
uint64_t valueCountInSlowestDim,
float minimumValue,
float maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds a 3d array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
minimumValueThe minimum value of the values to add. If NaN is provided then both minimum and maximum values will be computed from the values.
maximumValueThe maximum value of the values to add. If NaN is provided then both maximum and minimum values will be computed from the values.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.

◆ pushBackFloatHdf5ArrayOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackFloatHdf5ArrayOfValues ( float const * values,
uint64_t const * numValues,
unsigned int numArrayDimensions,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds an nd array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf minimumValue == nullptr and maximumValue != nullptr .
std::invalid_argumentIf minimumValue != nullptr and maximumValue == nullptr .
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numArrayDimensionsThe number of dimensions of the array to write.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.
[in]minimumValueThe minimum value (or value vector) of the values to add. If nullptr is provided for both minimumValue and maximumValue then both minimum and maximum values will be computed from the values.
[in]maximumValueThe maximum value (or value vector) of the values to add. If @ nullptr is provided for both maximumValue and minimumValue then both minimum and maximum values will be computed from the values.

◆ pushBackFloatHdf5ArrayOfValues() [2/2]

void resqml2::ContinuousProperty::pushBackFloatHdf5ArrayOfValues ( float const * values,
uint64_t const * numValues,
unsigned int numArrayDimensions,
float * minimumValue,
float * maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Adds an nd array of explicit float values to the property values.

Exceptions
std::invalid_argumentIf minimumValue == nullptr and maximumValue != nullptr .
std::invalid_argumentIf minimumValue != nullptr and maximumValue == nullptr .
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined in the repository.
std::invalid_argumentIf minimumValue == nullptr and maximumValue != nullptr .
std::invalid_argumentIf minimumValue != nullptr and maximumValue == nullptr .
Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numArrayDimensionsThe number of dimensions of the array to write.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository.
[in]minimumValueThe minimum value (or value vector) of the values to add. If nullptr is provided for both minimumValue and maximumValue then both minimum and maximum values will be computed from the values.
[in]maximumValueThe maximum value (or value vector) of the values to add. If @ nullptr is provided for both maximumValue and minimumValue then both minimum and maximum values will be computed from the values.

◆ pushBackHdf5Array1dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackHdf5Array1dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCount,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 1d array of explicit double values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountThe number of values to write.
minimumValueThe minimum value of the values to add. If NaN is provided (default) then neither minimum nor maximum value will be set.
maximumValueThe maximum value of the values to add. If NaN is provided (default) then neither maximum nor minimum value will be set.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5Array1dOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackHdf5Array1dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCount,
int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 1d array of values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountThe number of values to write).
nullvalueThe integer null value in case we create an integer array. It is ignored if the datatype is a floating point one.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5Array2dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackHdf5Array2dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 2d array of explicit double values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
minimumValueThe minimum value of the values to add. If NaN is provided (default) then neither minimum nor maximum value will be set.
maximumValueThe maximum value of the values to add. If NaN is provided (default) then neither maximum nor minimum value will be set.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5Array2dOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackHdf5Array2dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 2d array of values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
nullvalueThe integer null value in case we create an integer array. It is ignored if the datatype is a floating point one.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5Array3dOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackHdf5Array3dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
uint64_t valueCountInSlowestDim,
double minimumValue,
double maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 3d array of explicit float values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
minimumValueThe minimum value of the values to add. If NaN is provided (default) then neither minimum nor maximum value will be set.
maximumValueThe maximum value of the values to add. If NaN is provided (default) then neither maximum nor minimum value will be set.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5Array3dOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackHdf5Array3dOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t valueCountInFastestDim,
uint64_t valueCountInMiddleDim,
uint64_t valueCountInSlowestDim,
int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
eml2 ::AbstractHdfProxy * proxy = nullptr )

Creates a 3d array of values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
nullvalueThe integer null value in case we create an integer array. It is ignored if the datatype is a floating point one.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5ArrayOfValues() [1/2]

void resqml2::ContinuousProperty::pushBackHdf5ArrayOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t const * numValues,
unsigned int numArrayDimensions,
double * minimumValue,
double * maximumValue,
eml2 ::AbstractHdfProxy * proxy = nullptr )

Create an nd array of explicit float values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
numValuesThe number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
numArrayDimensionsThe number of dimensions of the array to write.
[in]minimumValueThe minimum value (or value vector) of the values to add. If nullptr (default) is provided then neither minimum nor maximum value will be set.
[in]maximumValueThe maximum value (or value vector) of the values to add. If nullptr (default) is provided then neither maximum nor minimum value will be set.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackHdf5ArrayOfValues() [2/2]

void resqml2::AbstractValuesProperty::pushBackHdf5ArrayOfValues ( common ::AbstractObject::numericalDatatypeEnum datatype,
uint64_t const * numValues,
unsigned int numArrayDimensions,
int64_t nullValue = (std::numeric_limits<int64_t>::max)(),
eml2 ::AbstractHdfProxy * proxy = nullptr )

Create an nd array of values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
Parameters
datatypeThe datatype of the values
numValuesThe number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
numArrayDimensionsThe number of dimensions of the array to write.
nullvalueThe integer null value in case we create an integer array. It is ignored if the datatype is a floating point one.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.

◆ pushBackRefToExistingIntegerDataset()

std::string resqml2::ContinuousProperty::pushBackRefToExistingIntegerDataset ( eml2 ::AbstractHdfProxy * ,
const std::string & ,
int64_t  )
inlinefinalvirtual

Please use std::string pushBackRefToExistingDataset(EML2_NS::AbstractHdfProxy* proxy, const std::string & datasetName = "") instead. Notice the lack of null value parameter.

Reimplemented from resqml2::AbstractValuesProperty.

◆ setMaximumValue()

virtual void resqml2::ContinuousProperty::setMaximumValue ( double value,
unsigned int index = 0 ) const
pure 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).

◆ setMinimumValue()

virtual void resqml2::ContinuousProperty::setMinimumValue ( double value,
unsigned int index = 0 ) const
pure virtual

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).

◆ setValuesOfFloatHdf5Array3dOfValues()

void resqml2::ContinuousProperty::setValuesOfFloatHdf5Array3dOfValues ( float const * 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,
uint64_t patchIndex = (std::numeric_limits< uint64_t >::max)() )

Sets some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. Since this methods only pushes back values into an existing array, it is to be used along with pushBackFloatHdf5Array3dOfValues().

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
std::out_of_rangeIf patchIndex is strictly greater than patch count and different from unsigned int maximum value.
Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
offsetInFastestDimThe offset value for writing in the fastest dimension (mainly I dimension).
offsetInMiddleDimThe offset value for writing in the middle dimension (mainly J dimension).
offsetInSlowestDimThe offset value for writing in the slowest dimension (mainly K dimension).
computeMinMaxTrue if FESAPI needs to compute the min and max from the given values in order to set them.
[in,out]proxyThe HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.
patchIndex(Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index).

◆ setValuesOfFloatHdf5ArrayOfValues()

void resqml2::ContinuousProperty::setValuesOfFloatHdf5ArrayOfValues ( float const * values,
uint64_t const * numValues,
uint64_t const * offsetValues,
unsigned int numArrayDimensions,
bool computeMinMax,
eml2 ::AbstractHdfProxy * proxy = nullptr,
uint64_t patchIndex = (std::numeric_limits< uint64_t >::max)() )

Set some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. This method is to be used along with one of the pushBackFloatHdf5ArrayOfValues() methods which do not write any value.

Exceptions
std::invalid_argumentIf proxy is nullptr and no default HDF proxy is defined into the data object repository.
std::out_of_rangeIf patchIndex is strictly greater than patch count and different from unsigned int maximum value.
Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
offsetValuesThe offset values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
numArrayDimensionsThe number of dimensions of the array to write.
computeMinMaxTrue if FESAPI needs to compute the min and max from the given values in order to set them.
[in,out]proxy(Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository.
patchIndex(Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index).

Member Data Documentation

◆ XML_TAG

const char* resqml2::ContinuousProperty::XML_TAG
static

The standard XML tag without XML namespace for serializing this data object.


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