Inheritance diagram for RESQML2_0_1_NS::ContinuousProperty:

Public Member Functions
	ContinuousProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	ContinuousProperty (RESQML2_NS::AbstractRepresentation *rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, const gsoap_resqml2_0_1::resqml2__ResqmlUom &uom, const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &energisticsPropertyKind)

	ContinuousProperty (RESQML2_NS::AbstractRepresentation rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, const gsoap_resqml2_0_1::resqml2__ResqmlUom &uom, RESQML2_NS::PropertyKind localPropKind)

	ContinuousProperty (RESQML2_NS::AbstractRepresentation *rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, const std::string &nonStandardUom, const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &energisticsPropertyKind)

	ContinuousProperty (RESQML2_NS::AbstractRepresentation rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, const std::string &nonStandardUom, RESQML2_NS::PropertyKind localPropKind)

	ContinuousProperty (gsoap_resqml2_0_1::_resqml2__ContinuousProperty *fromGsoap)

virtual	~ContinuousProperty ()

virtual std::string	getXmlTag () const

const gsoap_resqml2_0_1::resqml2__ResqmlUom &	getUom () const

std::string	getUomAsString () const

void	pushBackDoubleHdf5Array1dOfValues (double values, const ULONG64 &valueCount, COMMON_NS::AbstractHdfProxy proxy, const double &minimumValue=std::numeric_limits< double >::quiet_NaN(), const double &maximumValue=std::numeric_limits< double >::quiet_NaN())

void	pushBackDoubleHdf5Array2dOfValues (double values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy proxy, const double &minimumValue=std::numeric_limits< double >::quiet_NaN(), const double &maximumValue=std::numeric_limits< double >::quiet_NaN())

void	pushBackDoubleHdf5Array3dOfValues (double values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy proxy, const double &minimumValue=std::numeric_limits< double >::quiet_NaN(), const double &maximumValue=std::numeric_limits< double >::quiet_NaN())

void	pushBackDoubleHdf5ArrayOfValues (double values, unsigned long long numValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy, double minimumValue=nullptr, double *maximumValue=nullptr)

void	pushBackFloatHdf5Array1dOfValues (float values, const ULONG64 &valueCount, COMMON_NS::AbstractHdfProxy proxy, const float &minimumValue=std::numeric_limits< float >::quiet_NaN(), const float &maximumValue=std::numeric_limits< float >::quiet_NaN())

void	pushBackFloatHdf5Array2dOfValues (float values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy proxy, const float &minimumValue=std::numeric_limits< float >::quiet_NaN(), const float &maximumValue=std::numeric_limits< float >::quiet_NaN())

void	pushBackFloatHdf5Array3dOfValues (float values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy proxy, const float &minimumValue=std::numeric_limits< float >::quiet_NaN(), const float &maximumValue=std::numeric_limits< float >::quiet_NaN())

void	pushBackFloatHdf5ArrayOfValues (float values, unsigned long long numValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy, float minimumValue=nullptr, float *maximumValue=nullptr)

void	pushBackFloatHdf5ArrayOfValues (unsigned long long numValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy)

void	pushBackFloatHdf5ArrayOfValues (const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy)

void	setValuesOfFloatHdf5ArrayOfValues (float values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, const ULONG64 &offsetInFastestDim, const ULONG64 &offsetInMiddleDim, const ULONG64 &offsetInSlowestDim, COMMON_NS::AbstractHdfProxy proxy, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())

void	setValuesOfFloatHdf5ArrayOfValues (float values, unsigned long long numValues, unsigned long long offsetValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())

std::string	pushBackRefToExistingDataset (COMMON_NS::AbstractHdfProxy *hdfProxy, const std::string &datasetName="", const long &nullValue=(std::numeric_limits< long >::max)())

void	getDoubleValuesOfPatch (const unsigned int &patchIndex, double *values)

void	getFloatValuesOfPatch (const unsigned int &patchIndex, float *values)

void	getFloatValuesOfPatch (const unsigned int &patchIndex, float values, unsigned long long numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numArrayDimensions)

void	getFloatValuesOf3dPatch (const unsigned int &patchIndex, float *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, const ULONG64 &offsetInFastestDim, const ULONG64 &offsetInMiddleDim, const ULONG64 &offsetInSlowestDim)

double	getMinimumValue ()

double	getMaximumValue ()

bool	validatePropertyKindAssociation (RESQML2_NS::PropertyKind *pk)

bool	validatePropertyKindAssociation (const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &pk)

Public Member Functions inherited from RESQML2_NS::AbstractValuesProperty
	AbstractValuesProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractValuesProperty ()

	AbstractValuesProperty (gsoap_resqml2_0_1::resqml2__AbstractValuesProperty *fromGsoap)

virtual	~AbstractValuesProperty ()

unsigned int	getPatchCount () const

AbstractValuesProperty::hdfDatatypeEnum	getValuesHdfDatatype () const

long	getLongValuesOfPatch (const unsigned int &patchIndex, long *values)

long	getNullValueOfPatch (const unsigned int &patchIndex)

unsigned long	getULongValuesOfPatch (const unsigned int &patchIndex, unsigned long *values)

int	getIntValuesOfPatch (const unsigned int &patchIndex, int *values)

int	getIntValuesOfPatch (const unsigned int &patchIndex, int values, unsigned long long numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numArrayDimensions)

void	getIntValuesOf3dPatch (const unsigned int &patchIndex, int *values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim)

unsigned int	getUIntValuesOfPatch (const unsigned int &patchIndex, unsigned int *values)

short	getShortValuesOfPatch (const unsigned int &patchIndex, short *values)

unsigned short	getUShortValuesOfPatch (const unsigned int &patchIndex, unsigned short *values)

char	getCharValuesOfPatch (const unsigned int &patchIndex, char *values)

unsigned char	getUCharValuesOfPatch (const unsigned int &patchIndex, unsigned char *values)

unsigned int	getValuesCountOfPatch (const unsigned int &patchIndex)

unsigned int	getValuesCountOfDimensionOfPatch (const unsigned int &dimIndex, const unsigned int &patchIndex)

unsigned int	getDimensionsCountOfPatch (const unsigned int &patchIndex)

void	pushBackFacet (const gsoap_resqml2_0_1::resqml2__Facet &facet, const std::string &facetValue)

unsigned int	getFacetCount () const

gsoap_resqml2_0_1::resqml2__Facet	getFacet (const unsigned int &index) const

std::string	getFacetValue (const unsigned int &index) const

void	createLongHdf5ArrayOfValues (unsigned long long numValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy)

void	createLongHdf5Array3dOfValues (const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy)

void	pushBackLongHdf5SlabArray3dOfValues (long values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim, COMMON_NS::AbstractHdfProxy proxy)

void	pushBackLongHdf5SlabArrayOfValues (long values, unsigned long long numValues, unsigned long long offsetValues, const unsigned int &numArrayDimensions, COMMON_NS::AbstractHdfProxy proxy)

void	getLongValuesOfPatch (const unsigned int &patchIndex, long values, unsigned long long numValuesInEachDimension, unsigned long long *offsetInEachDimension, const unsigned int &numArrayDimensions)

void	getLongValuesOf3dPatch (const unsigned int &patchIndex, long *values, const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, const unsigned int &offsetInFastestDim, const unsigned int &offsetInMiddleDim, const unsigned int &offsetInSlowestDim)

Public Member Functions inherited from RESQML2_NS::AbstractProperty
	AbstractProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractProperty ()

	AbstractProperty (gsoap_resqml2_0_1::resqml2__AbstractProperty *fromGsoap)

virtual	~AbstractProperty ()

void	setRepresentation (class AbstractRepresentation *rep)

gsoap_resqml2_0_1::eml20__DataObjectReference *	getRepresentationDor () const

class AbstractRepresentation *	getRepresentation () const

std::string	getRepresentationUuid () const

std::string	getRepresentationTitle () const

std::string	getRepresentationContentType () const

void	setTimeSeries (class TimeSeries *ts)

TimeSeries *	getTimeSeries () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	getTimeSeriesDor () const

std::string	getTimeSeriesUuid () const

std::string	getTimeSeriesTitle () const

void	setTimeIndex (const unsigned int &timeIndex, class TimeSeries *ts)

void	setTimeStep (const unsigned int &timeStep)

time_t	getTimestamp () const

unsigned int	getTimeIndex () const

void	setHdfProxy (COMMON_NS::AbstractHdfProxy *proxy)

COMMON_NS::AbstractHdfProxy *	getHdfProxy () const

std::string	getHdfProxyUuid () const

unsigned int	getElementCountPerValue () const

gsoap_resqml2_0_1::resqml2__IndexableElements	getAttachmentKind () const

bool	isAssociatedToOneStandardEnergisticsPropertyKind () const

std::string	getPropertyKindDescription () const

std::string	getPropertyKindAsString () const

std::string	getPropertyKindParentAsString () const

gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind	getEnergisticsPropertyKind () const

void	setLocalPropertyKind (class PropertyKind *propKind)

gsoap_resqml2_0_1::eml20__DataObjectReference *	getLocalPropertyKindDor () const

std::string	getLocalPropertyKindUuid () const

std::string	getLocalPropertyKindTitle () const

class PropertyKind *	getLocalPropertyKind () const

Public Member Functions inherited from COMMON_NS::AbstractObject
bool	isPartial () 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	getVersionString () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (const time_t &creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (const time_t &lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setFormat (const std::string &format)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersionString (const std::string &versionString)

void	setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getGsoapProxy () const

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_resqml2_0_1::resqml2__ContactElementReference *	newResqmlContactElementReference () const

COMMON_NS::EpcDocument *	getEpcDocument () const

virtual std::string	getXmlNamespace () const

virtual std::string	getResqmlVersion () const

virtual std::string	getContentType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (const unsigned int &index) const

std::string	getAliasTitleAtIndex (const unsigned int &index) const

const std::vector< RESQML2_NS::Activity * > &	getActivitySet () const

unsigned int	getActivityCount () const

RESQML2_NS::Activity *	getActivity (const unsigned int &index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::tr1::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 (const unsigned int &index) const

std::string	getExtraMetadataStringValueAtIndex (const unsigned int &index) const

Static Public Attributes
static const char *	XML_TAG = "ContinuousProperty"

Protected Member Functions
	ContinuousProperty ()

Protected Member Functions inherited from RESQML2_NS::AbstractValuesProperty
std::string	getPathInHdfFileOfPatch (const unsigned int &patchIndex, LONG64 &nullValue) const

std::string	pushBackRefToExistingIntegerDataset (COMMON_NS::AbstractHdfProxy *hdfProxy, const std::string &datasetName="", const long &nullValue=(std::numeric_limits< long >::max)())

Protected Member Functions inherited from RESQML2_NS::AbstractProperty
void	setXmlRepresentation (class AbstractRepresentation *rep)

void	setXmlTimeSeries (TimeSeries *ts)

void	setXmlLocalPropertyKind (class PropertyKind *propKind)

virtual std::vector< epc::Relationship >	getAllEpcRelationships () const

virtual void	importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)

Protected Member Functions inherited from COMMON_NS::AbstractObject
	AbstractObject ()
	Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.

	AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)

	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)

void	initMandatoryMetadata ()

void	setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	cannotBePartial () const

void	changeToPartialObject ()

Additional Inherited Members
Public Types inherited from RESQML2_NS::AbstractValuesProperty
enum	hdfDatatypeEnum { UNKNOWN = 0, DOUBLE = 1, FLOAT = 2, LONG = 3, ULONG = 4, INT = 5, UINT = 6, SHORT = 7, USHORT = 8, CHAR = 9, UCHAR = 10 }

Protected Types inherited from COMMON_NS::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }

Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void	addActivityToResqmlObject (RESQML2_NS::Activity activity, AbstractObject resqmlObject)

Protected Attributes inherited from RESQML2_NS::AbstractProperty
class AbstractLocal3dCrs *	local3dCrs

Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1

gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1

COMMON_NS::EpcDocument *	epcDocument

std::vector< RESQML2_NS::Activity * >	activitySet

bool	updateXml

Constructor & Destructor Documentation

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty ( )

inlineprotected

Default constructor

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty	(	RESQML2_NS::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		const gsoap_resqml2_0_1::resqml2__ResqmlUom &	uom,
		const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &	energisticsPropertyKind
	)

Creates an instance of this class in a gsoap context based on a standard kind and a standard uom.

Parameters

rep	The representation which supports these property values.
guid	The guid to set to the fault. If empty then a new guid will be generated.
title	A title for the instance to create.
dimension	The dimension of each value (scalar properties == 1).
attachmentKind	The topological orbit which supports each value.
uom	The uom of the values. Please check EpcDocument::getEnergisticsUnitOfMeasure(const std::string & energisticsUomName) in order to minimize the use of non standard uom.
energisticsPropertyKind	The property kind of these property values which must be defined in the standard energistics property type dictionary.

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty	(	RESQML2_NS::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		const gsoap_resqml2_0_1::resqml2__ResqmlUom &	uom,
		RESQML2_NS::PropertyKind *	localPropKind
	)

Creates an instance of this class in a gsoap context based on a local kind and a standard uom.

Parameters

rep	The representation which supports these property values.
guid	The guid to set to the fault. If empty then a new guid will be generated.
title	A title for the instance to create.
dimension	The dimension of each value (scalar properties == 1).
attachmentKind	The topological orbit which supports each value.
uom	The uom of the values. Please check EpcDocument::getEnergisticsUnitOfMeasure(const std::string & energisticsUomName) in order to minimize the use of non standard uom.
localPropType	The property kind of these property values which must be defined in the EPC document as a local property kind.

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty	(	RESQML2_NS::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		const std::string &	nonStandardUom,
		const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &	energisticsPropertyKind
	)

Creates an instance of this class in a gsoap context based on a standard kind and a local uom.

Parameters

rep	The representation which supports these property values.
guid	The guid to set to the fault. If empty then a new guid will be generated.
title	A title for the instance to create.
dimension	The dimension of each value (scalar properties == 1).
attachmentKind	The topological orbit which supports each value.
nonStandardUom	The non standard uom of the values. Please check EpcDocument::getEnergisticsUnitOfMeasure(const std::string & energisticsUomName) in order to minimize the use of non standard uom.
energisticsPropertyKind	The property kind of these property values which must be defined in the standard energistics property type dictionary.

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty	(	RESQML2_NS::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		const std::string &	nonStandardUom,
		RESQML2_NS::PropertyKind *	localPropKind
	)

Creates an instance of this class in a gsoap context based on a local kind and a local uom.

Parameters

rep	The representation which supports these property values.
guid	The guid to set to the fault. If empty then a new guid will be generated.
title	A title for the instance to create.
dimension	The dimension of each value (scalar properties == 1).
attachmentKind	The topological orbit which supports each value.
nonStandardUom	The non standard uom of the values. Please check EpcDocument::getEnergisticsUnitOfMeasure(const std::string & energisticsUomName) in order to minimize the use of non standard uom.
localPropType	The property kind of these property values which must be defined in the EPC document as a local property kind.

RESQML2_0_1_NS::ContinuousProperty::ContinuousProperty ( gsoap_resqml2_0_1::_resqml2__ContinuousProperty * fromGsoap )

inline

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

virtual RESQML2_0_1_NS::ContinuousProperty::~ContinuousProperty ( )

inlinevirtual

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

Member Function Documentation

void ContinuousProperty::getDoubleValuesOfPatch	(	const unsigned int &	patchIndex,
		double *	values
	)

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

Parameters

patchIndex	The index of the patch we want the values from.
values	The array (pointer) of values must be preallocated.

void ContinuousProperty::getFloatValuesOf3dPatch	(	const unsigned int &	patchIndex,
		float *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		const ULONG64 &	offsetInFastestDim,
		const ULONG64 &	offsetInMiddleDim,
		const ULONG64 &	offsetInSlowestDim
	)

Get some of the values of a particular patch of the instance which are supposed to be float ones. This method makes use of HDF5 hyperslabbing.

Parameters

patchIndex	The index of the patch we want the values from.
values	The array (pointer) of values must be preallocated.
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 to read in the fastest dimension (mainly I dimension).
offsetInMiddleDim	The offset value to read in the middle dimension (mainly J dimension).
offsetInSlowestDim	The offset value to read in the slowest dimension (mainly K dimension).

void ContinuousProperty::getFloatValuesOfPatch	(	const unsigned int &	patchIndex,
		float *	values
	)

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

Parameters

patchIndex	The index of the patch we want the values from.
values	The array (pointer) of values must be preallocated.

void ContinuousProperty::getFloatValuesOfPatch	(	const unsigned int &	patchIndex,
		float *	values,
		unsigned long long *	numValuesInEachDimension,
		unsigned long long *	offsetInEachDimension,
		const unsigned int &	numArrayDimensions
	)

Get some of the values of a particular patch of the instance which are supposed to be float ones. This method makes use of HDF5 hyperslabbing.

Parameters

patchIndex	The index of the patch we want the values from.
values	The array (pointer) of values must be preallocated.
numValuesInEachDimension	The number of property values ordered by dimension of the array to write.
offsetInEachDimension	The offset values ordered by dimension of the array to write.
numArrayDimensions	The number of dimensions of the HDF5 array to read.

const gsoap_resqml2_0_1::resqml2__ResqmlUom & ContinuousProperty::getUom ( ) const

Get the unit of measure of the values of this property. If 'Euc' is returned, you should check if an extrametadata called "Uom" also exists. If so, it would mean that the property uses a non standard uom. This is an official workaround for a known issue of Resqml 2.0.1.

std::string ContinuousProperty::getUomAsString ( ) const

Get the unit of measure of the values of this property as a string. If 'Euc' is returned, you should check if an extrametadata called "Uom" also exists. If so, it would mean that the property uses a non standard uom. This is an official workaround for a known issue of Resqml 2.0.1.

virtual std::string RESQML2_0_1_NS::ContinuousProperty::getXmlTag ( ) const

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

Reimplemented in RESQML2_0_1_NS::ContinuousPropertySeries.

void ContinuousProperty::pushBackDoubleHdf5Array1dOfValues	(	double *	values,
		const ULONG64 &	valueCount,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const double &	minimumValue = `std::numeric_limits<double>::quiet_NaN()`,
		const double &	maximumValue = `std::numeric_limits<double>::quiet_NaN()`
	)

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

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.
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackDoubleHdf5Array2dOfValues	(	double *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const double &	minimumValue = `std::numeric_limits<double>::quiet_NaN()`,
		const double &	maximumValue = `std::numeric_limits<double>::quiet_NaN()`
	)

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

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).
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackDoubleHdf5Array3dOfValues	(	double *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const double &	minimumValue = `std::numeric_limits<double>::quiet_NaN()`,
		const double &	maximumValue = `std::numeric_limits<double>::quiet_NaN()`
	)

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

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).
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackDoubleHdf5ArrayOfValues	(	double *	values,
		unsigned long long *	numValues,
		const unsigned int &	numArrayDimensions,
		COMMON_NS::AbstractHdfProxy *	proxy,
		double *	minimumValue = `nullptr`,
		double *	maximumValue = `nullptr`
	)

Add an array (potentially multi dimensions) of explicit double values to the property values.

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.
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.
minimumValue	The minimum value (or value vector) of the values to add. If nullptr is provided and the dimension of value is 1 then the minimum value will be computed from the values.
maximumValue	The maximum value (or value vector) of the values to add. If nullptr is provided and the dimension of value is 1 then the maximum value will be computed from the values.

void ContinuousProperty::pushBackFloatHdf5Array1dOfValues	(	float *	values,
		const ULONG64 &	valueCount,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const float &	minimumValue = `std::numeric_limits<float>::quiet_NaN()`,
		const float &	maximumValue = `std::numeric_limits<float>::quiet_NaN()`
	)

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

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.
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackFloatHdf5Array2dOfValues	(	float *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const float &	minimumValue = `std::numeric_limits<float>::quiet_NaN()`,
		const float &	maximumValue = `std::numeric_limits<float>::quiet_NaN()`
	)

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

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 slowest dimension (mainly I dimension).
valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly J dimension).
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackFloatHdf5Array3dOfValues	(	float *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy,
		const float &	minimumValue = `std::numeric_limits<float>::quiet_NaN()`,
		const float &	maximumValue = `std::numeric_limits<float>::quiet_NaN()`
	)

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

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 slowest dimension (mainly I dimension).
valueCountInMiddleDim	The number of values to write in the slowest dimension (mainly J dimension).
valueCountInSlowestDim	The number of values to write in the slowest dimension (mainly K dimension).
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.
minimumValue	The minimum value of the values to add. If NAN is provided then the minimum value will be computed from the values.
maximumValue	The maximum value of the values to add. If NAN is provided then the maximum value will be computed from the values.

void ContinuousProperty::pushBackFloatHdf5ArrayOfValues	(	float *	values,
		unsigned long long *	numValues,
		const unsigned int &	numArrayDimensions,
		COMMON_NS::AbstractHdfProxy *	proxy,
		float *	minimumValue = `nullptr`,
		float *	maximumValue = `nullptr`
	)

Add an array (potentially multi dimensions) of explicit float values to the property values.

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.
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.
minimumValue	The minimum value (or value vector) of the values to add. If nullptr is provided and the dimension of value is 1 then the minimum value will be computed from the values.
maximumValue	The maximum value (or value vector) of the values to add. If nullptr is provided and the dimension of value is 1 then the maximum value will be computed from the values.

void ContinuousProperty::pushBackFloatHdf5ArrayOfValues	(	unsigned long long *	numValues,
		const unsigned int &	numArrayDimensions,
		COMMON_NS::AbstractHdfProxy *	proxy
	)

Create an array (potentially multi dimensions) of explicit float values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.

Parameters

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

void ContinuousProperty::pushBackFloatHdf5ArrayOfValues	(	const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy
	)

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

Parameters

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

std::string ContinuousProperty::pushBackRefToExistingDataset	(	COMMON_NS::AbstractHdfProxy *	hdfProxy,
		const std::string &	datasetName = `""`,
		const long &	nullValue = `(std::numeric_limits<long>::max)()`
	)

virtual

Push back a new patch of values for this property where the values have not to be written in the HDF 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 defered in time.

Parameters

hdfProxy	The HDF5 proxy where the values are already or will be stored.
datasetName	If not provided during the method call, the dataset will be named the same as the dataset naming convention of the fesapi :"/RESQML/" + prop->uuid + "/values_patch" + patchIndex;
nullValue	Only relevant for integer hdf5 datasets. Indeed, Resqml (and fesapi) forces null value for floating point ot be NaN value.

Returns: The name of the hdf5 dataset.

Implements RESQML2_NS::AbstractValuesProperty.

void ContinuousProperty::setValuesOfFloatHdf5ArrayOfValues	(	float *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		const ULONG64 &	offsetInFastestDim,
		const ULONG64 &	offsetInMiddleDim,
		const ULONG64 &	offsetInSlowestDim,
		COMMON_NS::AbstractHdfProxy *	proxy,
		unsigned int	patchIndex = `(std::numeric_limits<unsigned int>::max)()`
	)

Set some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. This method is to be used along with createFloatHdf5ArrayOfValues.

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).
offsetInFastestDim	The offset to write in the fastest dimension (mainly I dimension).
offsetInMiddleDim	The offset value to write in the middle dimension (mainly J dimension).
offsetInSlowestDim	The offset value to write in the slowest dimension (mainly K dimension).
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.
patchIndex	The index of the patch we want to set some values. If not present, the last patch is arbitrarily taken into account.

void ContinuousProperty::setValuesOfFloatHdf5ArrayOfValues	(	float *	values,
		unsigned long long *	numValues,
		unsigned long long *	offsetValues,
		const unsigned int &	numArrayDimensions,
		COMMON_NS::AbstractHdfProxy *	proxy,
		unsigned int	patchIndex = `(std::numeric_limits<unsigned int>::max)()`
	)

Set some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. This method is to be used along with createFloatHdf5ArrayOfValues.

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.
offsetValues	The offset values ordered by dimension of the array to write.
numArrayDimensions	The number of dimensions of the array to write.
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.
patchIndex	The index of the patch we want to set some values. If not present, the last patch is arbitrarily taken into account.

bool ContinuousProperty::validatePropertyKindAssociation ( RESQML2_NS::PropertyKind * pk )

virtual

Check if the associated local property kind is allowed for this property.

Implements RESQML2_NS::AbstractProperty.

bool ContinuousProperty::validatePropertyKindAssociation ( const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind & pk )

virtual

Check if the associated standard property kind is allowed for this property.

Implements RESQML2_NS::AbstractProperty.

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

C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/ContinuousProperty.h
C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/ContinuousProperty.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation