resqml2::DiscreteProperty Class Reference

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	pushBackInt64Hdf5Array1dOfValues (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 int 64 bits values to the property values.
void	pushBackInt32Hdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
void	pushBackInt16Hdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
void	pushBackInt8Hdf5Array1dOfValues (const int8_t *values, uint64_t valueCount, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue, int8_t minimumValue, int8_t maximumValue)
void	pushBackInt64Hdf5Array2dOfValues (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 int 64 bits values to the property values.
void	pushBackInt32Hdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
void	pushBackInt16Hdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
void	pushBackUInt16Hdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue)
void	pushBackInt8Hdf5Array2dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue, int8_t minimumValue, int8_t maximumValue)
void	pushBackInt64Hdf5Array3dOfValues (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 int 64 bits values to the property values.
void	pushBackInt32Hdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
void	pushBackInt16Hdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
void	pushBackUInt16Hdf5Array3dOfValues (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	pushBackInt8Hdf5Array3dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue, int8_t minimumValue, int8_t maximumValue)
void	pushBackInt64Hdf5ArrayOfValues (const int64_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int64_t nullValue) final
	Adds an nd array of explicit int 64 bits values to the property values.
void	pushBackInt32Hdf5ArrayOfValues (const int *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int nullValue) final
void	pushBackInt16Hdf5ArrayOfValues (const short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, short nullValue) final
void	pushBackUInt16Hdf5ArrayOfValues (const unsigned short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue) final
void	pushBackInt8Hdf5ArrayOfValues (const int8_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue) final
void	pushBackInt64Hdf5ArrayOfValues (const int64_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)
	Adds an nd array of explicit int 64 bits values to the property values.
void	pushBackInt32Hdf5ArrayOfValues (const int *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int nullValue, int minimumValue, int maximumValue)
void	pushBackInt16Hdf5ArrayOfValues (const short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, short nullValue, short minimumValue, short maximumValue)
void	pushBackUInt16Hdf5ArrayOfValues (const unsigned short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, unsigned short nullValue, unsigned short minimumValue, unsigned short maximumValue)
void	pushBackInt8Hdf5ArrayOfValues (const int8_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2 ::AbstractHdfProxy *proxy, int8_t nullValue, int8_t minimumValue, int8_t maximumValue)
virtual std::string	pushBackRefToExistingIntegerDataset (eml2 ::AbstractHdfProxy *proxy, const std::string &datasetName, int64_t nullValue, int64_t minimumValue, int64_t maximumValue)=0
void	pushBackHdf5ArrayOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, const uint64_t *numValues, unsigned int numArrayDimensions, int64_t *minimumValue, int64_t *maximumValue, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
void	pushBackHdf5Array1dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCount, int64_t minimumValue, int64_t maximumValue, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
void	pushBackHdf5Array2dOfValues (common ::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, int64_t minimumValue, int64_t maximumValue, 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 minimumValue, int64_t maximumValue, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2 ::AbstractHdfProxy *proxy=nullptr)
void	setValuesOfInt64Hdf5Array3dOfValues (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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
void	setValuesOfInt32Hdf5Array3dOfValues (int32_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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
void	setValuesOfInt64Hdf5ArrayOfValues (int64_t *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, bool computeMinMax, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
void	setValuesOfInt32Hdf5ArrayOfValues (int32_t *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, bool computeMinMax, eml2 ::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
virtual int64_t	getNullValue (uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)()) const =0
	Gets the null value in this discrete property.
virtual bool	hasMinimumValue (uint64_t 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).
virtual int64_t	getMinimumValue (uint64_t index=0) const =0
	Gets the minimum value of a non vector property or the minimum value of one given value of a vector property. This minimum value is read (it is not computed).
virtual bool	hasMaximumValue (uint64_t 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).
virtual int64_t	getMaximumValue (uint64_t index=0) const =0
	Gets the maximum value of a non vector property or the maximum value of one given value of a vector property. This maximum value is read (it is not computed).
virtual void	setMinimumValue (int64_t value, uint64_t index=0) const =0
	Sets the minimum value of a non vector property or the minimum value of one given value of a vector property.
virtual void	setMaximumValue (int64_t value, uint64_t 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.
virtual std::string	getXmlTag () const final
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 std::string	pushBackRefToExistingIntegerDataset (eml2 ::AbstractHdfProxy *hdfProxy, const std::string &dataset="", int64_t nullValue=(std::numeric_limits< int64_t >::max)())
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	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	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	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	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)())

Static Public Attributes
static constexpr char const *	XML_TAG = "DiscreteProperty"

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.

Member Function Documentation

getMaximumValue()

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

getMinimumValue()

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

getNullValue()

virtual int64_t resqml2::DiscreteProperty::getNullValue ( uint64_t patchIndex = (std::numeric_limits< uint64_t >::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.

hasMaximumValue()

virtual bool resqml2::DiscreteProperty::hasMaximumValue ( uint64_t 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.

hasMinimumValue()

virtual bool resqml2::DiscreteProperty::hasMinimumValue ( uint64_t 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.

pushBackHdf5Array1dOfValues() [1/2]

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

Creates a 1d array of 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

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

pushBackHdf5Array1dOfValues() [2/2]

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

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

Exceptions

std::invalid_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() [1/2]

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

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

Exceptions

std::invalid_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.

pushBackHdf5Array2dOfValues() [2/2]

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

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

	datatype	The datatype of the values
	valueCountInFastestDim	The number of values in the fastest dimension (mainly I 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 int 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.

pushBackHdf5Array3dOfValues() [1/2]

void resqml2::DiscreteProperty::pushBackHdf5Array3dOfValues	(	common ::AbstractObject::numericalDatatypeEnum	datatype,
		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 int 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

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

pushBackHdf5Array3dOfValues() [2/2]

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

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

Exceptions

std::invalid_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() [1/2]

void resqml2::DiscreteProperty::pushBackHdf5ArrayOfValues	(	common ::AbstractObject::numericalDatatypeEnum	datatype,
		const uint64_t *	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 int 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

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

pushBackHdf5ArrayOfValues() [2/2]

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

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

Exceptions

std::invalid_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() [1/2]

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

pushBackInt16Hdf5Array1dOfValues() [2/2]

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

inline

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.

pushBackInt16Hdf5Array2dOfValues() [1/2]

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

pushBackInt16Hdf5Array2dOfValues() [2/2]

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

pushBackInt16Hdf5Array3dOfValues() [1/2]

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

pushBackInt16Hdf5Array3dOfValues() [2/2]

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

pushBackInt16Hdf5ArrayOfValues() [1/2]

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

final

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.

pushBackInt16Hdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackInt16Hdf5ArrayOfValues	(	const short *	values,
		const uint64_t *	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.

pushBackInt32Hdf5Array1dOfValues() [1/2]

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

pushBackInt32Hdf5Array1dOfValues() [2/2]

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

inline

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.

pushBackInt32Hdf5Array2dOfValues() [1/2]

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

pushBackInt32Hdf5Array2dOfValues() [2/2]

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

pushBackInt32Hdf5Array3dOfValues() [1/2]

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

pushBackInt32Hdf5Array3dOfValues() [2/2]

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

pushBackInt32Hdf5ArrayOfValues() [1/2]

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

final

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.

pushBackInt32Hdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackInt32Hdf5ArrayOfValues	(	const int *	values,
		const uint64_t *	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.

pushBackInt64Hdf5Array1dOfValues() [1/2]

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.

pushBackInt64Hdf5Array1dOfValues() [2/2]

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

inline

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

pushBackInt64Hdf5Array2dOfValues() [1/2]

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.

pushBackInt64Hdf5Array2dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackInt64Hdf5Array2dOfValues	(	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 int 64 bits 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.

pushBackInt64Hdf5Array3dOfValues() [1/2]

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.

pushBackInt64Hdf5Array3dOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackInt64Hdf5Array3dOfValues	(	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 int 64 bits 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.

pushBackInt64Hdf5ArrayOfValues() [1/2]

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

final

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

pushBackInt64Hdf5ArrayOfValues() [2/2]

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

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

pushBackInt8Hdf5Array1dOfValues() [1/2]

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

pushBackInt8Hdf5Array1dOfValues() [2/2]

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

inline

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

pushBackInt8Hdf5Array2dOfValues() [1/2]

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

pushBackInt8Hdf5Array2dOfValues() [2/2]

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

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

pushBackInt8Hdf5Array3dOfValues() [1/2]

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

pushBackInt8Hdf5Array3dOfValues() [2/2]

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

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

pushBackInt8Hdf5ArrayOfValues() [1/2]

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

final

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

pushBackInt8Hdf5ArrayOfValues() [2/2]

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

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

pushBackRefToExistingIntegerDataset() [1/2]

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

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.

pushBackUInt16Hdf5Array2dOfValues() [1/2]

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

pushBackUInt16Hdf5Array2dOfValues() [2/2]

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

pushBackUInt16Hdf5Array3dOfValues() [1/2]

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

pushBackUInt16Hdf5Array3dOfValues() [2/2]

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

pushBackUInt16Hdf5ArrayOfValues() [1/2]

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

final

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.

pushBackUInt16Hdf5ArrayOfValues() [2/2]

void resqml2::DiscreteProperty::pushBackUInt16Hdf5ArrayOfValues	(	const unsigned short *	values,
		const uint64_t *	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.

setMaximumValue()

virtual void resqml2::DiscreteProperty::setMaximumValue ( int64_t value, uint64_t 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).

setMinimumValue()

virtual void resqml2::DiscreteProperty::setMinimumValue ( int64_t value, uint64_t 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).

setValuesOfInt64Hdf5Array3dOfValues() [1/2]

void resqml2::DiscreteProperty::setValuesOfInt64Hdf5Array3dOfValues	(	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,
		uint64_t	patchIndex = (std::numeric_limits< uint64_t >::max)() )

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

setValuesOfInt64Hdf5Array3dOfValues() [2/2]

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() [1/2]

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

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

setValuesOfInt64Hdf5ArrayOfValues() [2/2]

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

Member Data Documentation

XML_TAG

constexpr char const* resqml2::DiscreteProperty::XML_TAG = "DiscreteProperty"

staticconstexpr

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.9.0.1/src/resqml2/DiscreteProperty.h