Inheritance diagram for resqml2_0_1::CategoricalProperty:

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

	CategoricalProperty (StringTableLookup *strLookup)

	CategoricalProperty (resqml2::AbstractRepresentation rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, class StringTableLookup strLookup, const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &energisticsPropertyKind)

	CategoricalProperty (resqml2::AbstractRepresentation rep, const std::string &guid, const std::string &title, const unsigned int &dimension, const gsoap_resqml2_0_1::resqml2__IndexableElements &attachmentKind, class StringTableLookup strLookup, resqml2::PropertyKind *localPropKind)

	CategoricalProperty (gsoap_resqml2_0_1::_resqml2__CategoricalProperty *fromGsoap)

virtual	~CategoricalProperty ()

virtual std::string	getXmlTag () const

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

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

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

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

void	pushBackUShortHdf5Array1dOfValues (unsigned short values, const ULONG64 &valueCount, common::AbstractHdfProxy proxy, const long &nullValue)

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

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

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

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

class StringTableLookup *	getStringLookup ()

std::string	getStringLookupUuid () const

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 = "CategoricalProperty"

Protected Member Functions
std::vector< epc::Relationship >	getAllEpcRelationships () const

virtual void	importRelationshipSetFromEpc (common::EpcDocument *epcDoc)

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)

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

Protected Attributes
class StringTableLookup *	stringLookup

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

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 }

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

Constructor & Destructor Documentation

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

inline

Only to be used in partial transfer context

resqml2_0_1::CategoricalProperty::CategoricalProperty	(	resqml2::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		const unsigned int &	dimension,
		const gsoap_resqml2_0_1::resqml2__IndexableElements &	attachmentKind,
		class StringTableLookup *	strLookup,
		const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind &	energisticsPropertyKind
	)

Creates an instance of this class which is of a well known Energistics property kind.

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.
strLookup	The string lookup which defines the possible string values and their keys.
energisticsPropertyKind	The property kind of these property values which must be defined in the standard energistics property type dictionary.

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

Creates an instance of this class which is of a local property kind.

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.
strLookup	The string lookup which defines the possible string values and their keys.
localPropKind	The property kind of these property values which must be defined in the EPC document as a local property kind.

resqml2_0_1::CategoricalProperty::CategoricalProperty ( gsoap_resqml2_0_1::_resqml2__CategoricalProperty * fromGsoap )

inline

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

virtual resqml2_0_1::CategoricalProperty::~CategoricalProperty ( )

inlinevirtual

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

Member Function Documentation

vector< Relationship > CategoricalProperty::getAllEpcRelationships ( ) const

protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Reimplemented from resqml2::AbstractProperty.

class StringTableLookup* resqml2_0_1::CategoricalProperty::getStringLookup ( )

inline

Get the string lookup which is associated to this categorical property values.

std::string CategoricalProperty::getStringLookupUuid ( ) const

Get the string lookup uuid which is associated to this categorical property values.

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

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

Reimplemented in resqml2_0_1::CategoricalPropertySeries.

void CategoricalProperty::importRelationshipSetFromEpc ( common::EpcDocument * epcDoc )

protectedvirtual

Resolve all relationships of the object in an epc document

Reimplemented from resqml2::AbstractProperty.

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

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

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.
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 CategoricalProperty::pushBackLongHdf5Array2dOfValues	(	long *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue
	)

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

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).
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 CategoricalProperty::pushBackLongHdf5Array3dOfValues	(	long *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue
	)

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

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

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

Add an array (potentially multi dimensions) of long values to the property values which will be stored in the HDF file identified by its HDF proxy.

Parameters

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

std::string CategoricalProperty::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.

void CategoricalProperty::pushBackUShortHdf5Array1dOfValues	(	unsigned short *	values,
		const ULONG64 &	valueCount,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue
	)

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

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.
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 CategoricalProperty::pushBackUShortHdf5Array2dOfValues	(	unsigned short *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue
	)

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

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).
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 CategoricalProperty::pushBackUShortHdf5Array3dOfValues	(	unsigned short *	values,
		const ULONG64 &	valueCountInFastestDim,
		const ULONG64 &	valueCountInMiddleDim,
		const ULONG64 &	valueCountInSlowestDim,
		common::AbstractHdfProxy *	proxy,
		const long &	nullValue
	)

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

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

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

Add an array (potentially multi dimensions) of unsigned short values to the property values which will be stored in the HDF file identified by its HDF proxy.

Parameters

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

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

virtual

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

Implements resqml2::AbstractProperty.

bool CategoricalProperty::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/CategoricalProperty.h
C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/CategoricalProperty.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation