#include <DiscreteProperty.h>

Inheritance diagram for resqml2_0_1::DiscreteProperty:

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

	DiscreteProperty (resqml2::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__ResqmlPropertyKind &energisticsPropertyKind)

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

	DiscreteProperty (gsoap_resqml2_0_1::_resqml2__DiscreteProperty *fromGsoap)

virtual	~DiscreteProperty ()

virtual std::string	getXmlTag () const

void	pushBackLongHdf5Array1dOfValues (long values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)

void	pushBackLongHdf5Array1dOfValues (long values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const long &nullValue)

void	pushBackIntHdf5Array1dOfValues (int values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)

void	pushBackIntHdf5Array1dOfValues (int values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const int &nullValue)

void	pushBackShortHdf5Array1dOfValues (short values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const short &nullValue, const short &minimumValue, const short &maximumValue)

void	pushBackShortHdf5Array1dOfValues (short values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const short &nullValue)

void	pushBackCharHdf5Array1dOfValues (char values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const char &nullValue, const char &minimumValue, const char &maximumValue)

void	pushBackCharHdf5Array1dOfValues (char values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const char &nullValue)

void	pushBackLongHdf5Array2dOfValues (long values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)

void	pushBackLongHdf5Array2dOfValues (long values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const long &nullValue)

void	pushBackIntHdf5Array2dOfValues (int values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)

void	pushBackIntHdf5Array2dOfValues (int values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const int &nullValue)

void	pushBackShortHdf5Array2dOfValues (short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const short &nullValue, const short &minimumValue, const short &maximumValue)

void	pushBackShortHdf5Array2dOfValues (short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const short &nullValue)

void	pushBackUShortHdf5Array2dOfValues (unsigned short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const unsigned short &nullValue, const unsigned short &minimumValue, const unsigned short &maximumValue)

void	pushBackUShortHdf5Array2dOfValues (unsigned short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const unsigned short &nullValue)

void	pushBackCharHdf5Array2dOfValues (char values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const char &nullValue, const char &minimumValue, const char &maximumValue)

void	pushBackCharHdf5Array2dOfValues (char values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const char &nullValue)

void	pushBackLongHdf5Array3dOfValues (long values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)

void	pushBackLongHdf5Array3dOfValues (long values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const long &nullValue)

void	pushBackIntHdf5Array3dOfValues (int values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)

void	pushBackIntHdf5Array3dOfValues (int values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const int &nullValue)

void	pushBackShortHdf5Array3dOfValues (short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const short &nullValue, const short &minimumValue, const short &maximumValue)

void	pushBackShortHdf5Array3dOfValues (short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const short &nullValue)

void	pushBackUShortHdf5Array3dOfValues (unsigned short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const unsigned short &nullValue, const unsigned short &minimumValue, const unsigned short &maximumValue)

void	pushBackUShortHdf5Array3dOfValues (unsigned short values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const unsigned short &nullValue)

void	pushBackCharHdf5Array3dOfValues (char values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const char &nullValue, const char &minimumValue, const char &maximumValue)

void	pushBackCharHdf5Array3dOfValues (char values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, common::AbstractHdfProxy proxy, const char &nullValue)

void	pushBackLongHdf5ArrayOfValues (long values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)

void	pushBackLongHdf5ArrayOfValues (long values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const long &nullValue)

void	pushBackIntHdf5ArrayOfValues (int values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)

void	pushBackIntHdf5ArrayOfValues (int values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const int &nullValue)

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

void	pushBackShortHdf5ArrayOfValues (short values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const short &nullValue)

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

void	pushBackUShortHdf5ArrayOfValues (unsigned short values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const unsigned short &nullValue)

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

void	pushBackCharHdf5ArrayOfValues (char values, unsigned long long numValues, const unsigned int &numDimensionsInArray, common::AbstractHdfProxy *proxy, const char &nullValue)

std::string	pushBackRefToExistingDataset (common::AbstractHdfProxy *proxy, const std::string &datasetName, const long &nullValue, const long &minimumValue, const long &maximumValue)

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

bool	validatePropertyKindAssociation (resqml2::PropertyKind *pk)

bool	validatePropertyKindAssociation (const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &pk)

Public Member Functions inherited from resqml2::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::AbstractHdfProxy proxy)

void	createLongHdf5Array3dOfValues (const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, common::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::AbstractHdfProxy proxy)

void	pushBackLongHdf5SlabArrayOfValues (long values, unsigned long long numValues, unsigned long long offsetValues, const unsigned int &numArrayDimensions, common::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::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::AbstractHdfProxy *proxy)

common::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::AbstractObject
bool	isPartial () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (const time_t &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (const time_t &lastUpdate)

void	setFormat (const std::string &format)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

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::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::Activity * > &	getActivitySet () const

unsigned int	getActivityCount () const

resqml2::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 = "DiscreteProperty"

Additional Inherited Members
Public Types inherited from resqml2::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::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }

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

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

Protected Member Functions inherited from resqml2::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::EpcDocument *epcDoc)

Protected Member Functions inherited from common::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 ()

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

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

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

gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1

common::EpcDocument *	epcDocument

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

bool	updateXml

Detailed Description

This class is mainly useful for describing temporal properties on well objects. The prefered approach to describe temporal properties on Reservoir grids is to use one instance of DiscreteProperty per time step.

Constructor & Destructor Documentation

resqml2_0_1::DiscreteProperty::DiscreteProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

resqml2_0_1::DiscreteProperty::DiscreteProperty	(	resqml2::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__ResqmlPropertyKind &	energisticsPropertyKind
	)

Creates an instance of this class in a gsoap context.

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 support each value.
energisticsPropertyKind	The property kind of these property values which must be defined in the standard energistics property type dictionary.

resqml2_0_1::DiscreteProperty::DiscreteProperty	(	resqml2::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		resqml2::PropertyKind *	localPropKind
	)

Creates an instance of this class in a gsoap context.

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 support each value.
localPropType	The property kind of these property values which must be defined in the EPC document as a local property kind.

resqml2_0_1::DiscreteProperty::DiscreteProperty ( gsoap_resqml2_0_1::_resqml2__DiscreteProperty * fromGsoap )

inline

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

virtual resqml2_0_1::DiscreteProperty::~DiscreteProperty ( )

inlinevirtual

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

Member Function Documentation

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

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

Reimplemented in resqml2_0_1::DiscretePropertySeries.

void DiscreteProperty::pushBackLongHdf5Array1dOfValues	(	long *	values,
		const ULONG64 &	valueCount,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue,
		const long &	minimumValue,
		const long &	maximumValue
	)

Add a 1d array of explicit long 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 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.

void DiscreteProperty::pushBackLongHdf5Array2dOfValues	(	long *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue,
		const long &	minimumValue,
		const long &	maximumValue
	)

Add a 2d array of explicit long 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 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.

void DiscreteProperty::pushBackLongHdf5Array3dOfValues	(	long *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue,
		const long &	minimumValue,
		const long &	maximumValue
	)

Add a 3d array of explicit long 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 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.

void DiscreteProperty::pushBackLongHdf5ArrayOfValues	(	long *	values,
		unsigned long long *	numValues,
		const unsigned int &	numDimensionsInArray,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue,
		const long &	minimumValue,
		const long &	maximumValue
	)

Add an array (potentially multi dimensions) of explicit 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.
numDimensionsInArray	The number of dimensions in 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 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.

std::string DiscreteProperty::pushBackRefToExistingDataset	(	common::AbstractHdfProxy *	proxy,
		const std::string &	datasetName,
		const long &	nullValue,
		const long &	minimumValue,
		const long &	maximumValue
	)

Push back a a reference to an existing (or a "to exist") HDF5 dataset in a particular hdf proxy. The reason can be that the indice values already exist in an external file (only HDF5 for now) or that the writing of these indice values in the external file is defered in time.

Parameters

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 the fesapi : "/RESQML/" + prop->uuid + "/values_patch" + patch->RepresentationPatchIndex;
hdfProxy	The HDF5 proxy where the values are already or will be stored.
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.

std::string DiscreteProperty::pushBackRefToExistingDataset	(	common::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 to be NaN value.

Returns: The name of the hdf5 dataset.

Implements resqml2::AbstractValuesProperty.

bool DiscreteProperty::validatePropertyKindAssociation ( resqml2::PropertyKind * pk )

virtual

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

Implements resqml2::AbstractProperty.

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

virtual

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

Implements resqml2::AbstractProperty.

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation