Proxy class for an abstract values property. More...

#include <AbstractValuesProperty.h>

Inheritance diagram for resqml2::AbstractValuesProperty:

Public Member Functions
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)

virtual std::string	pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *hdfProxy, const std::string &dataset="", int64_t nullValue=(std::numeric_limits< int64_t >::max)())

bool	hasConstantValues (uint64_t patchIndex) const

int64_t	getInt64ConstantValuesOfPatch (uint64_t patchIndex) const

double	getDoubleConstantValuesOfPatch (uint64_t patchIndex) const

int64_t	getNullValueOfPatch (uint64_t patchIndex) const

int64_t	getInt64ValuesOfPatch (uint64_t patchIndex, int64_t *values) const

uint64_t	getUInt64ValuesOfPatch (uint64_t patchIndex, uint64_t *values) 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

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

void	setLocalCrs (eml2::AbstractLocal3dCrs *crs)

eml2::AbstractLocal3dCrs *	getLocalCrs () 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::TimeSeries *	getTimeSeries () 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::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)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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	getXmlTag () 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)

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

std::vector< eml2::Activity * >	getActivitySet () const

uint64_t	getActivityCount () const

eml2::Activity *	getActivity (uint64_t 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

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 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 an abstract values property.

Constructor & Destructor Documentation

◆ ~AbstractValuesProperty()

virtual resqml2::AbstractValuesProperty::~AbstractValuesProperty ( )

virtualdefault

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

Member Function Documentation

◆ getDimensionsCountOfPatch()

uint64_t resqml2::AbstractValuesProperty::getDimensionsCountOfPatch ( uint64_t patchIndex ) const

finalvirtual

Gets the count of dimensions of the underlying HDF5 dataset of a given patch of this property.

Exceptions

std::range_error If patchIndex is strictly greater than patch count.

Parameters

patchIndex The index of the patch we want to count the dimensions from.

Returns: The number of values, 0 otherwise.

Implements resqml2::AbstractProperty.

◆ getDoubleConstantValuesOfPatch()

double resqml2::AbstractValuesProperty::getDoubleConstantValuesOfPatch ( uint64_t patchIndex ) const

Get the constant value of all values of this property as a double one. This method does not check if all given values are the same constant ones. It only checks if the property has been written using the optimized constant array.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.
std::invalid_argument	If the property does not have any double constant value.

Parameters

patchIndex The index of the patch we want to get the constant value from.

Returns: The constant value of all values of this property as a double one.

◆ getDoubleValuesOfPatch()

void resqml2::AbstractValuesProperty::getDoubleValuesOfPatch	(	uint64_t	patchIndex,
		double *	values ) const

Gets all the values of a particular patch of this instance which are supposed to be double ones.

Exceptions

std::out_of_range If patchIndex is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`.

◆ getFacetCount()

uint64_t resqml2::AbstractValuesProperty::getFacetCount ( ) const

Gets the count of facet of this instance

Returns: The facet count.

◆ getFacetKind()

gsoap_eml2_3::eml23__FacetKind resqml2::AbstractValuesProperty::getFacetKind ( uint64_t index ) const

Gets the facet at a particular index of the facet collection of this instance.

Exceptions

std::out_of_range If index is strictly greater than facet count.

Parameters

index Zero-based index of the facet we want to get.

Returns: The facet at index index.

◆ getFacetValue()

std::string resqml2::AbstractValuesProperty::getFacetValue ( uint64_t index ) const

Gets the facet value at a particular index of the facet collection of this instance.

Exceptions

std::out_of_range If index is strictly greater than facet count.

Parameters

index Zero-based index of the facet we want to get.

Returns: The facet value at index index.

◆ getFloatValuesOf3dPatch()

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

Get some of the values of a particular patch of the instance as float ones. This method makes use of HDF5 hyperslabbing.

Exceptions

std::out_of_range If patchIndex is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[in,out]	values	The array (pointer) of values must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
	valueCountInFastestDim	The number of values to read in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to read in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to read in the slowest dimension (mainly K dimension).
	offsetInFastestDim	The offset value for reading in the fastest dimension (mainly I dimension).
	offsetInMiddleDim	The offset value for reading in the middle dimension (mainly J dimension).
	offsetInSlowestDim	The offset value for reading in the slowest dimension (mainly K dimension).

◆ getFloatValuesOfPatch() [1/2]

void resqml2::AbstractValuesProperty::getFloatValuesOfPatch	(	uint64_t	patchIndex,
		float *	values ) const

Gets all the values of a particular patch of this instance which are supposed to be float ones.

Exceptions

std::out_of_range If patchIndex is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`.

◆ getFloatValuesOfPatch() [2/2]

void resqml2::AbstractValuesProperty::getFloatValuesOfPatch	(	uint64_t	patchIndex,
		float *	values,
		uint64_t const *	numValuesInEachDimension,
		uint64_t const *	offsetInEachDimension,
		unsigned int	numArrayDimensions ) const

Get some of the values of a particular patch of the instance as float ones. This method makes use of HDF5 hyperslabbing.

Exceptions

std::out_of_range If patchIndex is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	The array (pointer) of values must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
	numValuesInEachDimension	The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
	offsetInEachDimension	The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the HDF5 array to read.

◆ getInt16ValuesOfPatch()

int16_t resqml2::AbstractValuesProperty::getInt16ValuesOfPatch	(	uint64_t	patchIndex,
		int16_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be signed 16 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getInt32ValuesOfPatch()

int32_t resqml2::AbstractValuesProperty::getInt32ValuesOfPatch	(	uint64_t	patchIndex,
		int32_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be signed 32 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getInt64ConstantValuesOfPatch()

int64_t resqml2::AbstractValuesProperty::getInt64ConstantValuesOfPatch ( uint64_t patchIndex ) const

Get the constant value of all values of this property as an integer one. This method does not check if all given values are the same constant ones. It only checks if the property has been written using the optimized constant array.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.
std::invalid_argument	If the property does not have any integer constant value.

Parameters

patchIndex The index of the patch we want to get the constant value from.

Returns: The constant value of all values of this property as an integer one.

◆ getInt64ValuesOf3dPatch()

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

Gets some of the values of a given patch of this instance. Values are supposed to be int 64 bits ones.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	The array (pointer) of values must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
	valueCountInFastestDim	The number of values to read in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to read in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to read in the slowest dimension (mainly K dimension).
	offsetInFastestDim	The offset value for reading in the fastest dimension (mainly I dimension).
	offsetInMiddleDim	The offset value for reading in the middle dimension (mainly J dimension).
	offsetInSlowestDim	The offset value for reading in the slowest dimension (mainly K dimension).

◆ getInt64ValuesOfPatch() [1/2]

int64_t resqml2::AbstractValuesProperty::getInt64ValuesOfPatch	(	uint64_t	patchIndex,
		int64_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be signed 64 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`.

Returns: The null value.

◆ getInt64ValuesOfPatch() [2/2]

void resqml2::AbstractValuesProperty::getInt64ValuesOfPatch	(	uint64_t	patchIndex,
		int64_t *	values,
		uint64_t const *	numValuesInEachDimension,
		uint64_t const *	offsetInEachDimension,
		unsigned int	numArrayDimensions ) const

Gets some of the values of a given patch of this instance. Values are supposed to be int 64 bits ones.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	The array (pointer) of values which must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
	numValuesInEachDimension	The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
	offsetInEachDimension	The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the array to write.

◆ getInt8ValuesOfPatch()

int8_t resqml2::AbstractValuesProperty::getInt8ValuesOfPatch	(	uint64_t	patchIndex,
		int8_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be signed 8 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getIntValuesOf3dPatch()

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

Gets some of the values of a given patch of this instance. Values are supposed to be integer ones.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	The array (pointer) of values must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
	valueCountInFastestDim	The number of values to read in the fastest dimension (mainly I dimension).
	valueCountInMiddleDim	The number of values to read in the middle dimension (mainly J dimension).
	valueCountInSlowestDim	The number of values to read in the slowest dimension (mainly K dimension).
	offsetInFastestDim	The offset value for reading in the fastest dimension (mainly I dimension).
	offsetInMiddleDim	The offset value for reading in the middle dimension (mainly J dimension).
	offsetInSlowestDim	The offset value for reading in the slowest dimension (mainly K dimension).

◆ getIntValuesOfPatch()

int32_t resqml2::AbstractValuesProperty::getIntValuesOfPatch	(	uint64_t	patchIndex,
		int32_t *	values,
		const uint64_t *	numValuesInEachDimension,
		const uint64_t *	offsetInEachDimension,
		unsigned int	numArrayDimensions ) const

Gets some of the values of a given patch of this instance. Values are supposed to be integer ones.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	The array (pointer) of values which must be preallocated. Size is `getValuesCountOfPatch(patchIndex)`.
[in]	numValuesInEachDimension	The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
[in]	offsetInEachDimension	The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension.
	numArrayDimensions	The number of dimensions of the array to read.

Returns: The null value.

◆ getNullValueOfPatch()

int64_t resqml2::AbstractValuesProperty::getNullValueOfPatch ( uint64_t patchIndex ) const

Gets the null value of a given patch of this instance. Values are supposed to be integer ones.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::range_error	If `patchIndex` is strictly greater than patch count.
std::invalid_argument	If the `patchIndex` patch does not contain integer values.

Parameters

patchIndex The index of the patch we want the values from.

Returns: the null value.

◆ getPatchCount()

uint64_t resqml2::AbstractValuesProperty::getPatchCount ( ) const

finalvirtual

Gets the number of patches in this values property. It should be the same count as the patch count of the associated representation.

Exceptions

std::out_of_range If the patch count is strictly greater than unsigned int max value.

Returns: The patch count.

Implements resqml2::AbstractProperty.

◆ getUInt16ValuesOfPatch()

uint16_t resqml2::AbstractValuesProperty::getUInt16ValuesOfPatch	(	uint64_t	patchIndex,
		uint16_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be unsigned 16 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getUInt32ValuesOfPatch()

uint32_t resqml2::AbstractValuesProperty::getUInt32ValuesOfPatch	(	uint64_t	patchIndex,
		uint32_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be unsigned 32 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getUInt64ValuesOfPatch()

uint64_t resqml2::AbstractValuesProperty::getUInt64ValuesOfPatch	(	uint64_t	patchIndex,
		uint64_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be unsigned 64 bits integer.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`.

Returns: The null value.

◆ getUInt8ValuesOfPatch()

uint8_t resqml2::AbstractValuesProperty::getUInt8ValuesOfPatch	(	uint64_t	patchIndex,
		uint8_t *	values ) const

Gets all the values of a given patch of this instance. Values are supposed to be signed 8 bits integer

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

	patchIndex	The index of the patch we want the values from.
[out]	values	Preallocated buffer for receiving the values. Size is `getValuesCountOfPatch(patchIndex)`

Returns: The null value.

◆ getValuesCountOfDimensionOfPatch()

uint64_t resqml2::AbstractValuesProperty::getValuesCountOfDimensionOfPatch	(	uint64_t	dimIndex,
		uint64_t	patchIndex ) const

finalvirtual

Gets the count of values on a specific dimension of the underlying HDF5 dataset of a given patch of this property.

Exceptions

std::out_of_range	If `dimIndex` is strictly greater than dimension count.
std::range_error	If `patchIndex` is strictly greater than patch count.

Parameters

dimIndex	The index of the dimension we want to count the values from.
patchIndex	The index of the patch we want to count the values from.

Returns: The count of values in the dimIndex dimension of patchIndex patch.

Implements resqml2::AbstractProperty.

◆ getValuesHdfDatatype()

common::AbstractObject::numericalDatatypeEnum resqml2::AbstractValuesProperty::getValuesHdfDatatype ( ) const

finalvirtual

Get the values data type in the HDF dataset

Returns: The data type of the values if successful, else UNKNOWN.

Implements resqml2::AbstractProperty.

◆ hasConstantValues()

bool resqml2::AbstractValuesProperty::hasConstantValues ( uint64_t patchIndex ) const

Check if this property has all its values set to a constant ones. This method does not check if all given values are the same constant ones. It only checks if the property has been written using the optimized constant array.

Exceptions

std::logic_error	If the underlying gSOAP instance is not a RESQML2.0 one.
std::out_of_range	If `patchIndex` is strictly greater than patch count.

Parameters

patchIndex The index of the patch we want to check the values from.

Returns: True if the property has been written using the optimized constant array.

◆ pushBackDoubleHdf5Array1dOfValues()

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_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.
	valueCount	The 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()

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_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).
	valueCountInSlowestDim	The 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()

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

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_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.
	numValues	The number of property values ordered by dimension of the array to write.
	numArrayDimensions	The 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.

◆ pushBackFacet()

void resqml2::AbstractValuesProperty::pushBackFacet	(	gsoap_eml2_3::eml23__FacetKind	facet,
		const std::string &	facetValue )

Pushes back a new facet to this instance. Facets are qualifiers for property values which allow users to semantically specialize a property without creating a new property kind.

Parameters

facet	The facet.
facetValue	The facet value.

◆ pushBackFloatHdf5Array1dOfValues()

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_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.
	valueCount	The 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.

◆ pushBackFloatHdf5Array2dOfValues()

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_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).
	valueCountInSlowestDim	The 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.

◆ pushBackFloatHdf5Array3dOfValues()

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

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_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.
	numValues	The number of property values ordered by dimension of the array to write.
	numArrayDimensions	The 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.

◆ pushBackFloatingPointConstantArrayOfValues()

void resqml2::AbstractValuesProperty::pushBackFloatingPointConstantArrayOfValues	(	double	value,
		uint64_t	valueCount )

Adds an array constant flaoting point values to the property values.

Exceptions

std::logic_error If the underlying gSOAP instance is not a RESQML2.0 or 2.2 one.

Parameters

value	The constant value in the array.
valueCount	The number of values to write.

◆ pushBackHdf5Array1dOfValues()

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

Parameters

	datatype	The datatype of the values
	valueCount	The number of values to write).
	nullvalue	The 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()

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

Parameters

	datatype	The datatype of the values
	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 K dimension).
	nullvalue	The 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()

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

Parameters

	datatype	The datatype of the values
	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).
	nullvalue	The 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()

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

Parameters

	datatype	The datatype of the values
	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	The 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.

◆ pushBackInt16Hdf5Array1dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt16Hdf5Array1dOfValues	(	const short *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue )

Adds a 1d array of explicit short 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.

◆ pushBackInt16Hdf5Array2dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt16Hdf5Array2dOfValues	(	const short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue )

Adds a 2d array of explicit short 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.

◆ pushBackInt16Hdf5Array3dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt16Hdf5Array3dOfValues	(	const short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue )

Adds a 3d array of explicit short 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.

◆ pushBackInt16Hdf5ArrayOfValues()

virtual void resqml2::AbstractValuesProperty::pushBackInt16Hdf5ArrayOfValues	(	const short *	values,
		const uint64_t *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		short	nullValue )

virtual

Adds an nd array of explicit short 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.

Reimplemented in resqml2::DiscreteProperty.

◆ pushBackInt32Hdf5Array1dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt32Hdf5Array1dOfValues	(	const int *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue )

Adds a 1d array of explicit integer 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.

◆ pushBackInt32Hdf5Array2dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt32Hdf5Array2dOfValues	(	const int *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue )

Adds a 2d array of explicit integer 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.

◆ pushBackInt32Hdf5Array3dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt32Hdf5Array3dOfValues	(	const int *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue )

Adds a 3d array of explicit integer 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.

◆ pushBackInt32Hdf5ArrayOfValues()

virtual void resqml2::AbstractValuesProperty::pushBackInt32Hdf5ArrayOfValues	(	const int *	values,
		const uint64_t *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int	nullValue )

virtual

Adds an nd array of explicit integer 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.

Reimplemented in resqml2::DiscreteProperty.

◆ pushBackInt64Hdf5Array1dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt64Hdf5Array1dOfValues	(	const int64_t *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		int64_t	nullValue )

inline

Adds a 1d array of explicit int 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.

◆ pushBackInt64Hdf5Array2dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt64Hdf5Array2dOfValues	(	const int64_t *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int64_t	nullValue )

inline

Adds a 2d array of explicit int 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.

◆ pushBackInt64Hdf5Array3dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt64Hdf5Array3dOfValues	(	const int64_t *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int64_t	nullValue )

inline

Adds a 3d array of explicit int 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.

◆ pushBackInt64Hdf5ArrayOfValues()

virtual void resqml2::AbstractValuesProperty::pushBackInt64Hdf5ArrayOfValues	(	const int64_t *	values,
		const uint64_t *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int64_t	nullValue )

virtual

Adds an nd array of explicit int 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.

Reimplemented in resqml2::DiscreteProperty.

◆ pushBackInt8Hdf5Array1dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt8Hdf5Array1dOfValues	(	const int8_t *	values,
		uint64_t	valueCount,
		eml2::AbstractHdfProxy *	proxy,
		int8_t	nullValue )

Adds a 1d array of explicit int8_t 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.

◆ pushBackInt8Hdf5Array2dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt8Hdf5Array2dOfValues	(	const int8_t *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int8_t	nullValue )

Adds a 2d array of explicit int8_t 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.

◆ pushBackInt8Hdf5Array3dOfValues()

void resqml2::AbstractValuesProperty::pushBackInt8Hdf5Array3dOfValues	(	const int8_t *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		int8_t	nullValue )

Adds a 3d array of explicit int8_t 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.

◆ pushBackInt8Hdf5ArrayOfValues()

virtual void resqml2::AbstractValuesProperty::pushBackInt8Hdf5ArrayOfValues	(	const int8_t *	values,
		const uint64_t *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		int8_t	nullValue )

virtual

Adds an nd array of explicit int8_t 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.

Reimplemented in resqml2::DiscreteProperty.

◆ pushBackIntegerConstantArrayOfValues()

void resqml2::AbstractValuesProperty::pushBackIntegerConstantArrayOfValues	(	int64_t	value,
		uint64_t	valueCount )

Adds an array constant integer values to the property values.

Exceptions

std::logic_error If the underlying gSOAP instance is not a RESQML2.0 or 2.2 one.

Parameters

value	The constant value in the array.
valueCount	The number of values to write.

◆ pushBackRefToExistingFloatingPointDataset()

virtual std::string resqml2::AbstractValuesProperty::pushBackRefToExistingFloatingPointDataset	(	eml2::AbstractHdfProxy *	proxy,
		const std::string &	datasetName = "" )

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 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	(Optional) 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" + patchIndex`

Returns: The name of the referenced HDF5 dataset.

◆ pushBackRefToExistingIntegerDataset()

virtual std::string resqml2::AbstractValuesProperty::pushBackRefToExistingIntegerDataset	(	eml2::AbstractHdfProxy *	hdfProxy,
		const std::string &	dataset = "",
		int64_t	nullValue = (std::numeric_limits< int64_t >::max)() )

virtual

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.

Reimplemented in resqml2::CommentProperty, resqml2::ContinuousProperty, and resqml2::DiscreteProperty.

◆ pushBackUInt16Hdf5Array2dOfValues()

void resqml2::AbstractValuesProperty::pushBackUInt16Hdf5Array2dOfValues	(	const unsigned short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue )

Adds a 2d array of explicit unsigned short 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.

◆ pushBackUInt16Hdf5Array3dOfValues()

void resqml2::AbstractValuesProperty::pushBackUInt16Hdf5Array3dOfValues	(	const unsigned short *	values,
		uint64_t	valueCountInFastestDim,
		uint64_t	valueCountInMiddleDim,
		uint64_t	valueCountInSlowestDim,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue )

Adds a 3d array of explicit unsigned short 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.

◆ pushBackUInt16Hdf5ArrayOfValues()

virtual void resqml2::AbstractValuesProperty::pushBackUInt16Hdf5ArrayOfValues	(	const unsigned short *	values,
		const uint64_t *	numValues,
		unsigned int	numDimensionsInArray,
		eml2::AbstractHdfProxy *	proxy,
		unsigned short	nullValue )

virtual

Adds an nd array of explicit unsigned short 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.

Reimplemented in resqml2::DiscreteProperty.

◆ setValuesOfInt64Hdf5Array1dOfValues()

void resqml2::AbstractValuesProperty::setValuesOfInt64Hdf5Array1dOfValues	(	int64_t const *	values,
		uint64_t	valueCount,
		uint64_t	offset,
		eml2::AbstractHdfProxy *	proxy = nullptr,
		uint64_t	patchIndex = (std::numeric_limits<uint64_t>::max)() )

inline

Adds a 1d array of explicit int 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 pushBackInt64Hdf5Array3dOfValues().

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.
	valueCount	The number of values to write.
	offset	The offset 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.
	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).

◆ setValuesOfInt64Hdf5Array2dOfValues()

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

inline

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

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

◆ setValuesOfInt64Hdf5Array3dOfValues()

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

inline

Adds a 3d array of explicit int 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 pushBackInt64Hdf5Array3dOfValues().

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

◆ setValuesOfInt64Hdf5ArrayOfValues()

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

inline

Adds an nd array of explicit int 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 pushBackInt64Hdf5ArrayOfValues().

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

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2/AbstractValuesProperty.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractValuesProperty()

Member Function Documentation

◆ getDimensionsCountOfPatch()

◆ getDoubleConstantValuesOfPatch()

◆ getDoubleValuesOfPatch()

◆ getFacetCount()

◆ getFacetKind()

◆ getFacetValue()

◆ getFloatValuesOf3dPatch()

◆ getFloatValuesOfPatch() [1/2]

◆ getFloatValuesOfPatch() [2/2]

◆ getInt16ValuesOfPatch()

◆ getInt32ValuesOfPatch()

◆ getInt64ConstantValuesOfPatch()

◆ getInt64ValuesOf3dPatch()

◆ getInt64ValuesOfPatch() [1/2]

◆ getInt64ValuesOfPatch() [2/2]

◆ getInt8ValuesOfPatch()

◆ getIntValuesOf3dPatch()

◆ getIntValuesOfPatch()

◆ getNullValueOfPatch()

◆ getPatchCount()

◆ getUInt16ValuesOfPatch()

◆ getUInt32ValuesOfPatch()

◆ getUInt64ValuesOfPatch()

◆ getUInt8ValuesOfPatch()

◆ getValuesCountOfDimensionOfPatch()

◆ getValuesHdfDatatype()

◆ hasConstantValues()

◆ pushBackDoubleHdf5Array1dOfValues()

◆ pushBackDoubleHdf5Array2dOfValues()

◆ pushBackDoubleHdf5Array3dOfValues()

◆ pushBackDoubleHdf5ArrayOfValues()

◆ pushBackFacet()

◆ pushBackFloatHdf5Array1dOfValues()

◆ pushBackFloatHdf5Array2dOfValues()

◆ pushBackFloatHdf5Array3dOfValues()

◆ pushBackFloatHdf5ArrayOfValues()

◆ pushBackFloatingPointConstantArrayOfValues()

◆ pushBackHdf5Array1dOfValues()

◆ pushBackHdf5Array2dOfValues()

◆ pushBackHdf5Array3dOfValues()

◆ pushBackHdf5ArrayOfValues()

◆ pushBackInt16Hdf5Array1dOfValues()

◆ pushBackInt16Hdf5Array2dOfValues()

◆ pushBackInt16Hdf5Array3dOfValues()

◆ pushBackInt16Hdf5ArrayOfValues()

◆ pushBackInt32Hdf5Array1dOfValues()

◆ pushBackInt32Hdf5Array2dOfValues()

◆ pushBackInt32Hdf5Array3dOfValues()

◆ pushBackInt32Hdf5ArrayOfValues()

◆ pushBackInt64Hdf5Array1dOfValues()

◆ pushBackInt64Hdf5Array2dOfValues()

◆ pushBackInt64Hdf5Array3dOfValues()

◆ pushBackInt64Hdf5ArrayOfValues()

◆ pushBackInt8Hdf5Array1dOfValues()

◆ pushBackInt8Hdf5Array2dOfValues()

◆ pushBackInt8Hdf5Array3dOfValues()

◆ pushBackInt8Hdf5ArrayOfValues()

◆ pushBackIntegerConstantArrayOfValues()

◆ pushBackRefToExistingFloatingPointDataset()

◆ pushBackRefToExistingIntegerDataset()

◆ pushBackUInt16Hdf5Array2dOfValues()

◆ pushBackUInt16Hdf5Array3dOfValues()

◆ pushBackUInt16Hdf5ArrayOfValues()

◆ setValuesOfInt64Hdf5Array1dOfValues()

◆ setValuesOfInt64Hdf5Array2dOfValues()

◆ setValuesOfInt64Hdf5Array3dOfValues()

◆ setValuesOfInt64Hdf5ArrayOfValues()