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

#include <DiscreteProperty.h>

Inheritance diagram for resqml2::DiscreteProperty:

Public Member Functions
virtual	~DiscreteProperty ()=default

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)

virtual std::string	pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)=0

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 int64_t	getNullValue (unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)()) const =0
	Gets the null value in this discrete property. More...

virtual bool	hasMinimumValue (unsigned int index=0) const =0
	Checks if a non vector property or a given value of a vector property has got a minimum value already computed (or set). More...

virtual int64_t	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). More...

virtual bool	hasMaximumValue (unsigned int index=0) const =0
	Checks if a non vector property or a given value of a vector property has got a maximum value already computed (or set). More...

virtual int64_t	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). More...

virtual void	setMinimumValue (int64_t 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. More...

virtual void	setMaximumValue (int64_t 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. More...

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

AbstractRepresentation *	getRepresentation () 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::PropertySet *	getPropertySet (unsigned int index) const

void	setLocalCrs (class AbstractLocal3dCrs *crs)

class AbstractLocal3dCrs *	getLocalCrs () 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::TimeSeries *	getTimeSeries () 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::PropertyKind *	getPropertyKind () const

virtual bool	validatePropertyKindAssociation (eml2::PropertyKind *pk)=0

virtual bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk)=0

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::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

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::Activity *	getActivity (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_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()

virtual resqml2::DiscreteProperty::~DiscreteProperty ( )

virtualdefault

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

Reimplemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

Member Function Documentation

◆ getMaximumValue()

virtual int64_t resqml2::DiscreteProperty::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).

Exceptions

std::logic_error If 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).

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ getMinimumValue()

virtual int64_t resqml2::DiscreteProperty::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).

Exceptions

std::logic_error If 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).

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ getNullValue()

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

pure virtual

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.

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ getXmlTag()

virtual std::string resqml2::DiscreteProperty::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ hasMaximumValue()

virtual bool resqml2::DiscreteProperty::hasMaximumValue ( unsigned int index = 0 ) const

pure virtual

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.

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ hasMinimumValue()

virtual bool resqml2::DiscreteProperty::hasMinimumValue ( unsigned int index = 0 ) const

pure virtual

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.

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ pushBackCharHdf5Array1dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackCharHdf5Array1dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5Array1dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackCharHdf5Array1dOfValues	(	const char *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		char	nullValue,
		char	minimumValue,
		char	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackCharHdf5Array2dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5Array2dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackCharHdf5Array2dOfValues	(	const char *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		char	nullValue,
		char	minimumValue,
		char	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5Array3dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackCharHdf5Array3dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5Array3dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackCharHdf5Array3dOfValues	(	const char *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		char	nullValue,
		char	minimumValue,
		char	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackCharHdf5ArrayOfValues() [1/2]

void resqml2::DiscreteProperty::pushBackCharHdf5ArrayOfValues	(	const char *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		char	nullValue
	)

finalvirtual

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackCharHdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackCharHdf5ArrayOfValues	(	const char *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		char	nullValue,
		char	minimumValue,
		char	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add. If not provided then the minimum value will be computed from the values.
	maximumValue	The maximum value of the values to add. If not provided then the maximum value will be computed from the values.

◆ pushBackIntHdf5Array1dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackIntHdf5Array1dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5Array1dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackIntHdf5Array1dOfValues	(	const int *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue,
		int	minimumValue,
		int	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackIntHdf5Array2dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5Array2dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackIntHdf5Array2dOfValues	(	const int *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue,
		int	minimumValue,
		int	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5Array3dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackIntHdf5Array3dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5Array3dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackIntHdf5Array3dOfValues	(	const int *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue,
		int	minimumValue,
		int	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackIntHdf5ArrayOfValues() [1/2]

void resqml2::DiscreteProperty::pushBackIntHdf5ArrayOfValues	(	const int *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue
	)

finalvirtual

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackIntHdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackIntHdf5ArrayOfValues	(	const int *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue,
		int	minimumValue,
		int	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add. If not provided then the minimum value will be computed from the values.
	maximumValue	The maximum value of the values to add. If not provided then the maximum value will be computed from the values.

◆ pushBackLongHdf5Array1dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackLongHdf5Array1dOfValues

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

◆ pushBackLongHdf5Array1dOfValues() [2/2]

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackLongHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackLongHdf5Array2dOfValues

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

◆ pushBackLongHdf5Array2dOfValues() [2/2]

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackLongHdf5Array3dOfValues() [1/4]

void resqml2::AbstractValuesProperty::pushBackLongHdf5Array3dOfValues

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

◆ pushBackLongHdf5Array3dOfValues() [2/4]

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackLongHdf5Array3dOfValues() [3/4]

void resqml2::DiscreteProperty::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`
	)

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.

Parameters

	valueCountInFastestDim	The number of values in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values in the slowest dimension (mainly K dimension).
	minimumValue	The minimum value of the values in the HDF5 dataset.
	maximumValue	The maximum value of the values in the HDF5 dataset.
	nullValue	(Optional) The null value. Default value is long 64 bits maximum value.
[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.

◆ pushBackLongHdf5Array3dOfValues() [4/4]

void resqml2::AbstractValuesProperty::pushBackLongHdf5Array3dOfValues

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.

Parameters

	valueCountInFastestDim	The number of values in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values in the slowest dimension (mainly K dimension).
	nullValue	(Optional) The null value. Default value is long 64 bits maximum value.
[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), a default HDF proxy must be defined into the data object repository.

◆ pushBackLongHdf5ArrayOfValues() [1/5]

virtual void resqml2::AbstractValuesProperty::pushBackLongHdf5ArrayOfValues

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

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

◆ pushBackLongHdf5ArrayOfValues() [2/5]

void resqml2::DiscreteProperty::pushBackLongHdf5ArrayOfValues	(	const int64_t *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int64_t	nullValue
	)

finalvirtual

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackLongHdf5ArrayOfValues() [3/5]

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add. If not provided then the minimum value will be computed from the values.
	maximumValue	The maximum value of the values to add. If not provided then the maximum value will be computed from the values.

◆ pushBackLongHdf5ArrayOfValues() [4/5]

void resqml2::DiscreteProperty::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`
	)

Creates an nd array of explicit long 64 bits values into the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.

Parameters

[in]	numValues	The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the array to write.
[in]	minimumValue	If non-nullptr, a pointer to the minimum values. If non- nullptr, the count of minimum values is this property count.
[in]	maximumValue	If non-nullptr, a pointer to the maximum values. If non- nullptr, the count of maximum values is this property count.
	nullValue	(Optional) The null value. Default value is long 64 bits maximum value.
[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.

◆ pushBackLongHdf5ArrayOfValues() [5/5]

void resqml2::AbstractValuesProperty::pushBackLongHdf5ArrayOfValues

Creates an nd array of explicit long 64 bits values into the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.

Parameters

[in]	numValues	The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the array to write.
	nullValue	(Optional) The null value. Default value is long 64 bits maximum value.
[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), a default HDF proxy must be defined into the data object repository.

◆ pushBackRefToExistingIntegerDataset() [1/2]

virtual std::string resqml2::AbstractValuesProperty::pushBackRefToExistingIntegerDataset

Pushes back a new patch of values for this property where the values have not to be written in the HDF5 file.The reason can be that the 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::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::invalid_argument	If `hdfProxy` is `nullptr` and no default HDF proxy is defined in the repository.

Parameters

[in]	hdfProxy	The HDF5 proxy where the values are already or will be stored. If `nullptr`, then a default HDF proxy must be defined in the repository.
	dataset	(Optional) If not provided during the method call, the dataset will be named the same as the dataset naming convention of fesapi : `getHdfGroup() + "/values_patch" + patchIndex`
	nullValue	(Optional) Only relevant for integer HDF5 datasets. Indeed, RESQML (and fesapi) forces null value for floating point to be `NaN` value.

Returns: The name of the HDF5 dataset.

◆ pushBackRefToExistingIntegerDataset() [2/2]

virtual std::string resqml2::DiscreteProperty::pushBackRefToExistingIntegerDataset	(	eml2::AbstractHdfProxy *	proxy,
		const std::string &	datasetName,
		int64_t	nullValue,
		int64_t	minimumValue,
		int64_t	maximumValue
	)

pure virtual

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_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

[in]	proxy	The HDF5 proxy where the values are already or will be stored. If `nullptr`, then a default HDF proxy must be defined in the repository.
	datasetName	The 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`
	nullValue	The null value which has been chosen in the referenced HDF dataset.
	minimumValue	The minimum value of the values in the HDF5 dataset.
	maximumValue	The maximum value of the values in the HDF5 dataset.

Returns: The name of the referenced HDF5 dataset.

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ pushBackShortHdf5Array1dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackShortHdf5Array1dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5Array1dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackShortHdf5Array1dOfValues	(	const short *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue,
		short	minimumValue,
		short	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCount	The number of values to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackShortHdf5Array2dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5Array2dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackShortHdf5Array2dOfValues	(	const short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue,
		short	minimumValue,
		short	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5Array3dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackShortHdf5Array3dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5Array3dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackShortHdf5Array3dOfValues	(	const short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue,
		short	minimumValue,
		short	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackShortHdf5ArrayOfValues() [1/2]

void resqml2::DiscreteProperty::pushBackShortHdf5ArrayOfValues	(	const short *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue
	)

finalvirtual

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackShortHdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackShortHdf5ArrayOfValues	(	const short *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue,
		short	minimumValue,
		short	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add. If not provided then the minimum value will be computed from the values.
	maximumValue	The maximum value of the values to add. If not provided then the maximum value will be computed from the values.

◆ pushBackUShortHdf5Array2dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackUShortHdf5Array2dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackUShortHdf5Array2dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackUShortHdf5Array2dOfValues	(	const unsigned short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue,
		unsigned short	minimumValue,
		unsigned short	maximumValue
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackUShortHdf5Array3dOfValues() [1/2]

void resqml2::AbstractValuesProperty::pushBackUShortHdf5Array3dOfValues

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackUShortHdf5Array3dOfValues() [2/2]

void resqml2::DiscreteProperty::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
	)

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

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add.
	maximumValue	The maximum value of the values to add.

◆ pushBackUShortHdf5ArrayOfValues() [1/2]

void resqml2::DiscreteProperty::pushBackUShortHdf5ArrayOfValues	(	const unsigned short *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue
	)

finalvirtual

Adds an nd array of explicit unsigned short values to the property values.

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackUShortHdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackUShortHdf5ArrayOfValues	(	const unsigned short *	values,
		unsigned long long *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue,
		unsigned short	minimumValue,
		unsigned short	maximumValue
	)

Adds an nd array of explicit unsigned short values to the property values.

Exceptions

std::invalid_argument If proxy is nullptr and no default HDF proxy is defined in the repository.

Parameters

	values	All the property values to set ordered according the topology of the representation it is based on.
[in]	numValues	The number of property values ordered by dimension of the array to write.
	numDimensionsInArray	The number of dimensions in the array to write.
[in,out]	proxy	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`, then a default HDF proxy must be defined in the repository.
	nullValue	The null value.
	minimumValue	The minimum value of the values to add. If not provided then the minimum value will be computed from the values.
	maximumValue	The maximum value of the values to add. If not provided then the maximum value will be computed from the values.

◆ setMaximumValue()

virtual void resqml2::DiscreteProperty::setMaximumValue	(	int64_t	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

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

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ setMinimumValue()

virtual void resqml2::DiscreteProperty::setMinimumValue	(	int64_t	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

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

Implemented in resqml2_2::DiscreteProperty, and resqml2_0_1::DiscreteProperty.

◆ setValuesOfLongHdf5Array3dOfValues() [1/2]

void resqml2::DiscreteProperty::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)()`
	)

Adds a 3d array of explicit long 64 bits values into the property values. Since this methods only pushes back values into an existing array, it is to be used along with pushBackLongHdf5Array3dOfValues().

Exceptions

std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.
std::out_of_range	If `patchIndex` is strictly greater than patch count and different from unsigned int maximum value.

Parameters

[in]	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
	offsetInFastestDim	The offset value for writing in the fastest dimension (mainly I dimension).
	offsetInMiddleDim	The offset value for writing in the middle dimension (mainly J dimension).
	offsetInSlowestDim	The offset value for writing in the slowest dimension (mainly K dimension).
	computeMinMax	True 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).

◆ setValuesOfLongHdf5Array3dOfValues() [2/2]

void resqml2::AbstractValuesProperty::setValuesOfLongHdf5Array3dOfValues

Adds a 3d array of explicit long 64 bits values into the property values. Since this methods only pushes back values into an existing array, it is to be used along with pushBackLongHdf5Array3dOfValues().

Exceptions

std::invalid_argument	If `proxy` is `nullptr` and no default HDF proxy is defined into the data object repository.
std::out_of_range	If `patchIndex` is strictly greater than patch count and different from unsigned int maximum value.

Parameters

[in]	values	All the property values to set ordered according to the topology of the representation it is based on.
	valueCountInFastestDim	The number of values to write in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to write in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
	offsetInFastestDim	The offset value for writing in the fastest dimension (mainly I dimension).
	offsetInMiddleDim	The offset value for writing in the middle dimension (mainly J dimension).
	offsetInSlowestDim	The offset value for writing 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), 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).

◆ setValuesOfLongHdf5ArrayOfValues()

void resqml2::DiscreteProperty::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)()`
	)

Adds an nd array of explicit long 64 bits values into to the property values. Since this methods only pushes back values into an existing array, it is to be used along with pushBackLongHdf5ArrayOfValues().

Exceptions

std::invalid_argument	If `proxy` is null and no default HDF proxy is defined into the data object repository.
std::out_of_range	If `patchIndex` is strictly greater than patch count and different from unsigned int maximum value.

Parameters

[in]	values	All the property values to set ordered according to the topology of the representation it is based on.
	numValues	The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
	offsetValues	The offset values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the array to write.
	computeMinMax	True to compute and to set minimum and maximum 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 null (default value), 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::DiscreteProperty::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:

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2/DiscreteProperty.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~DiscreteProperty()

Member Function Documentation

◆ getMaximumValue()

◆ getMinimumValue()

◆ getNullValue()

◆ getXmlTag()

◆ hasMaximumValue()

◆ hasMinimumValue()

◆ pushBackCharHdf5Array1dOfValues() [1/2]

◆ pushBackCharHdf5Array1dOfValues() [2/2]

◆ pushBackCharHdf5Array2dOfValues() [1/2]

◆ pushBackCharHdf5Array2dOfValues() [2/2]

◆ pushBackCharHdf5Array3dOfValues() [1/2]

◆ pushBackCharHdf5Array3dOfValues() [2/2]

◆ pushBackCharHdf5ArrayOfValues() [1/2]

◆ pushBackCharHdf5ArrayOfValues() [2/2]

◆ pushBackIntHdf5Array1dOfValues() [1/2]

◆ pushBackIntHdf5Array1dOfValues() [2/2]

◆ pushBackIntHdf5Array2dOfValues() [1/2]

◆ pushBackIntHdf5Array2dOfValues() [2/2]

◆ pushBackIntHdf5Array3dOfValues() [1/2]

◆ pushBackIntHdf5Array3dOfValues() [2/2]

◆ pushBackIntHdf5ArrayOfValues() [1/2]

◆ pushBackIntHdf5ArrayOfValues() [2/2]

◆ pushBackLongHdf5Array1dOfValues() [1/2]

◆ pushBackLongHdf5Array1dOfValues() [2/2]

◆ pushBackLongHdf5Array2dOfValues() [1/2]

◆ pushBackLongHdf5Array2dOfValues() [2/2]

◆ pushBackLongHdf5Array3dOfValues() [1/4]

◆ pushBackLongHdf5Array3dOfValues() [2/4]

◆ pushBackLongHdf5Array3dOfValues() [3/4]

◆ pushBackLongHdf5Array3dOfValues() [4/4]

◆ pushBackLongHdf5ArrayOfValues() [1/5]

◆ pushBackLongHdf5ArrayOfValues() [2/5]

◆ pushBackLongHdf5ArrayOfValues() [3/5]

◆ pushBackLongHdf5ArrayOfValues() [4/5]

◆ pushBackLongHdf5ArrayOfValues() [5/5]

◆ pushBackRefToExistingIntegerDataset() [1/2]

◆ pushBackRefToExistingIntegerDataset() [2/2]

◆ pushBackShortHdf5Array1dOfValues() [1/2]

◆ pushBackShortHdf5Array1dOfValues() [2/2]

◆ pushBackShortHdf5Array2dOfValues() [1/2]

◆ pushBackShortHdf5Array2dOfValues() [2/2]

◆ pushBackShortHdf5Array3dOfValues() [1/2]

◆ pushBackShortHdf5Array3dOfValues() [2/2]

◆ pushBackShortHdf5ArrayOfValues() [1/2]

◆ pushBackShortHdf5ArrayOfValues() [2/2]

◆ pushBackUShortHdf5Array2dOfValues() [1/2]

◆ pushBackUShortHdf5Array2dOfValues() [2/2]

◆ pushBackUShortHdf5Array3dOfValues() [1/2]

◆ pushBackUShortHdf5Array3dOfValues() [2/2]

◆ pushBackUShortHdf5ArrayOfValues() [1/2]

◆ pushBackUShortHdf5ArrayOfValues() [2/2]

◆ setMaximumValue()

◆ setMinimumValue()

◆ setValuesOfLongHdf5Array3dOfValues() [1/2]

◆ setValuesOfLongHdf5Array3dOfValues() [2/2]

◆ setValuesOfLongHdf5ArrayOfValues()

Member Data Documentation

◆ XML_TAG