resqml2_2::CategoricalProperty Class Reference

#include <CategoricalProperty.h>

Inheritance diagram for resqml2_2::CategoricalProperty:

Public Member Functions
	CategoricalProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	CategoricalProperty (resqml2::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::resqml22__IndexableElement attachmentKind, resqml2::StringTableLookup *strLookup, eml2::PropertyKind *localPropKind)
	Creates a categorical property. More...
	CategoricalProperty (resqml2::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::resqml22__IndexableElement attachmentKind, resqml2::DoubleTableLookup *dblLookup, eml2::PropertyKind *localPropKind)
	Creates a categorical property. More...
	CategoricalProperty (gsoap_eml2_3::_resqml22__CategoricalProperty *fromGsoap)
	~CategoricalProperty ()=default
common::DataObjectReference	getLookupDor () const final
bool	validatePropertyKindAssociation (eml2::PropertyKind *) final
bool	validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) final
std::string	getXmlNamespace () const final
Public Member Functions inherited from resqml2::CategoricalProperty
StringTableLookup *	getStringLookup () const
	Gets the string lookup which is associated to this categorical property values. More...
DoubleTableLookup *	getDoubleLookup () const
	Gets the double lookup which is associated to this categorical property values. More...
virtual std::string	getXmlTag () const final
Public Member Functions inherited from resqml2::AbstractValuesProperty
virtual	~AbstractValuesProperty ()=default
unsigned int	getPatchCount () const final
void	pushBackFacet (gsoap_eml2_3::eml23__FacetKind facet, const std::string &facetValue)
unsigned int	getFacetCount () const
gsoap_eml2_3::eml23__FacetKind	getFacetKind (unsigned int index) const
std::string	getFacetValue (unsigned int index) const
void	pushBackLongHdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
	Adds a 1d array of explicit long values to the property values. More...
void	pushBackIntHdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int nullValue)
void	pushBackShortHdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, short nullValue)
void	pushBackCharHdf5Array1dOfValues (const char *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, char nullValue)
void	pushBackLongHdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
	Adds a 2d array of explicit long values to the property values. More...
void	pushBackIntHdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
void	pushBackShortHdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
void	pushBackUShortHdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
void	pushBackCharHdf5Array2dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
void	pushBackLongHdf5Array3dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
	Adds a 3d array of explicit long values to the property values. More...
void	pushBackIntHdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
void	pushBackShortHdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
void	pushBackUShortHdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
void	pushBackCharHdf5Array3dOfValues (const char *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, char nullValue)
virtual void	pushBackLongHdf5ArrayOfValues (const int64_t *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
	Adds an nd array of explicit long values to the property values. More...
virtual void	pushBackIntHdf5ArrayOfValues (const int *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int nullValue)
virtual void	pushBackShortHdf5ArrayOfValues (const short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, short nullValue)
virtual void	pushBackUShortHdf5ArrayOfValues (const unsigned short *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
virtual void	pushBackCharHdf5ArrayOfValues (const char *values, unsigned long long *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, char nullValue)
virtual std::string	pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *hdfProxy, const std::string &dataset="", int64_t nullValue=(std::numeric_limits< int64_t >::max)())
int64_t	getLongValuesOfPatch (unsigned int patchIndex, int64_t *values) const
int64_t	getNullValueOfPatch (unsigned int patchIndex) const
uint64_t	getULongValuesOfPatch (unsigned int patchIndex, uint64_t *values) const
int	getIntValuesOfPatch (unsigned int patchIndex, int *values) const
unsigned int	getUIntValuesOfPatch (unsigned int patchIndex, unsigned int *values) const
short	getShortValuesOfPatch (unsigned int patchIndex, short *values) const
unsigned short	getUShortValuesOfPatch (unsigned int patchIndex, unsigned short *values) const
char	getCharValuesOfPatch (unsigned int patchIndex, char *values) const
unsigned char	getUCharValuesOfPatch (unsigned int patchIndex, unsigned char *values) const
void	pushBackLongHdf5ArrayOfValues (unsigned long long *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
void	pushBackLongHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
void	setValuesOfLongHdf5Array3dOfValues (int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
void	setValuesOfLongHdf5ArrayOfValues (int64_t *values, unsigned long long const *numValues, unsigned long long const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
void	getLongValuesOfPatch (unsigned int patchIndex, int64_t *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numArrayDimensions) const
void	getLongValuesOf3dPatch (unsigned int patchIndex, int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
int	getIntValuesOfPatch (unsigned int patchIndex, int *values, unsigned long long *numValuesInEachDimension, unsigned long long *offsetInEachDimension, unsigned int numArrayDimensions) const
void	getIntValuesOf3dPatch (unsigned int patchIndex, int *values, unsigned int valueCountInFastestDim, unsigned int valueCountInMiddleDim, unsigned int valueCountInSlowestDim, unsigned int offsetInFastestDim, unsigned int offsetInMiddleDim, unsigned int offsetInSlowestDim) const
void	pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy=nullptr)
	Adds a 1d array of explicit double values to the property values. More...
void	pushBackDoubleHdf5Array2dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
	Adds a 2d array of explicit double values to the property values. More...
void	pushBackDoubleHdf5Array3dOfValues (const double *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
	Adds a 3d array of explicit double values to the property values. More...
void	pushBackDoubleHdf5ArrayOfValues (double const *values, unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
	Adds an nd array of explicit double values to the property values. More...
void	pushBackFloatHdf5Array1dOfValues (const float *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy=nullptr)
void	pushBackFloatHdf5Array2dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
void	pushBackFloatHdf5Array3dOfValues (const float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
void	pushBackFloatHdf5ArrayOfValues (float const *values, unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
virtual std::string	pushBackRefToExistingFloatingPointDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName="")
void	getDoubleValuesOfPatch (unsigned int patchIndex, double *values) const
void	getFloatValuesOfPatch (unsigned int patchIndex, float *values) const
void	pushBackFloatHdf5ArrayOfValues (unsigned long long const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
void	pushBackFloatHdf5Array3dOfValues (uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr)
void	setValuesOfFloatHdf5Array3dOfValues (float const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
void	setValuesOfFloatHdf5ArrayOfValues (float const *values, unsigned long long const *numValues, unsigned long long const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, unsigned int patchIndex=(std::numeric_limits< unsigned int >::max)())
void	getFloatValuesOfPatch (unsigned int patchIndex, float *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numArrayDimensions) const
void	getFloatValuesOf3dPatch (unsigned int patchIndex, float *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
Public Member Functions inherited from resqml2::AbstractProperty
virtual	~AbstractProperty ()=default
void	setRepresentation (AbstractRepresentation *rep)
common::DataObjectReference	getRepresentationDor () const
AbstractRepresentation *	getRepresentation () const
unsigned int	getElementCountPerValue () const
gsoap_eml2_3::resqml22__IndexableElement	getAttachmentKind () const
common::AbstractObject::hdfDatatypeEnum	getValuesHdfDatatype () const
unsigned int	getValuesCountOfPatch (unsigned int patchIndex) const
unsigned int	getValuesCountOfDimensionOfPatch (unsigned int dimIndex, unsigned int patchIndex) const
unsigned int	getDimensionsCountOfPatch (unsigned int patchIndex) const
std::vector< resqml2::PropertySet * >	getPropertySets () const
unsigned int	getPropertySetCount () const
resqml2::PropertySet *	getPropertySet (unsigned int index) const
void	setLocalCrs (class AbstractLocal3dCrs *crs)
class AbstractLocal3dCrs *	getLocalCrs () const
common::DataObjectReference	getLocalCrsDor () const
bool	hasRealizationIndices () const
std::vector< unsigned int >	getRealizationIndices () const
void	setRealizationIndices (uint64_t startRealizationIndex, uint64_t countRealizationIndices)
void	setRealizationIndices (const std::vector< unsigned int > &realizationIndices, eml2::AbstractHdfProxy *hdfProxy=nullptr)
	Sets the realization indices of this property. More...
void	setTimeSeries (eml2::TimeSeries *ts)
eml2::TimeSeries *	getTimeSeries () const
common::DataObjectReference	getTimeSeriesDor () const
void	setTimeIndices (uint64_t startTimeIndex, uint64_t countTimeIndices, eml2::TimeSeries *ts, bool useInterval=false)
	Sets the timestamps of this property by means of an index in a time series. More...
unsigned int	getTimeIndexStart () const
unsigned int	getTimeIndicesCount () const
bool	useInterval () const
bool	isAssociatedToOneStandardEnergisticsPropertyKind () const
std::string	getPropertyKindDescription () const
std::string	getPropertyKindAsString () const
std::string	getPropertyKindParentAsString () const
void	setPropertyKind (eml2::PropertyKind *propKind)
common::DataObjectReference	getPropertyKindDor () const
eml2::PropertyKind *	getPropertyKind () const
bool	validate ()
Public Member Functions inherited from common::AbstractObject
bool	isPartial () const
virtual bool	isTopLevelElement () const
std::string	getUuid () const
std::string	getTitle () const
std::string	getEditor () const
time_t	getCreation () const
tm	getCreationAsTimeStructure () const
std::string	getOriginator () const
std::string	getDescription () const
time_t	getLastUpdate () const
tm	getLastUpdateAsTimeStructure () const
std::string	getFormat () const
std::string	getDescriptiveKeywords () const
std::string	getVersion () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (time_t creation)
void	setCreation (const tm &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (time_t lastUpdate)
void	setLastUpdate (const tm &lastUpdate)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
void	setVersion (const std::string &version)
void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)
void	serializeIntoStream (std::ostream *stream)
void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)
void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const
gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const
gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const
void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)
gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const
void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)
soap *	getGsoapContext () const
int	getGsoapType () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const
gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const
gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () const
gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const
gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const
gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const
common::DataObjectRepository *	getRepository () const
virtual std::string	getXmlNamespaceVersion () const
virtual std::string	getContentType () const
virtual std::string	getQualifiedType () const
virtual std::string	getPartNameInEpcDocument () const
std::string	serializeIntoString ()
void	addAlias (const std::string &authority, const std::string &title)
unsigned int	getAliasCount () const
std::string	getAliasAuthorityAtIndex (unsigned int index) const
std::string	getAliasTitleAtIndex (unsigned int index) const
std::vector< eml2::Activity * >	getActivitySet () const
unsigned int	getActivityCount () const
eml2::Activity *	getActivity (unsigned int index) const
void	pushBackExtraMetadata (const std::string &key, const std::string &value)
std::unordered_map< std::string, std::string >	getExtraMetadataSet () const
std::vector< std::string >	getExtraMetadata (const std::string &key) const
unsigned int	getExtraMetadataCount () const
std::string	getExtraMetadataKeyAtIndex (unsigned int index) const
std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Static Public Attributes
static const char *	XML_NS
Static Public Attributes inherited from resqml2::CategoricalProperty
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum {   UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 ,   ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 ,   USHORT = 8 , CHAR = 9 , UCHAR = 10 }
Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

Proxy class for a categorical property. It contains discrete integers. This type of property is associated either: as an internally stored index to a string through a lookup mapping, or as an internally stored double to another double value through an explicitly provided table.

Constructor & Destructor Documentation

CategoricalProperty() [1/4]

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

inline

Only to be used in partial transfer context

Parameters

[in]

partialObject

If non-null, the partial object.

CategoricalProperty() [2/4]

resqml2_2::CategoricalProperty::CategoricalProperty	(	resqml2::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::resqml22__IndexableElement	attachmentKind,
		resqml2::StringTableLookup *	strLookup,
		eml2::PropertyKind *	localPropKind
	)

Creates a categorical property.

Exceptions

std::invalid_argument

If rep, strLookup or propKind is null. If dimension is zero.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
[in]	strLookup	The string lookup which defines the possible string values and their keys. It cannot be null.
[in]	localPropKind	The property kind of these property values. It cannot be null.

CategoricalProperty() [3/4]

resqml2_2::CategoricalProperty::CategoricalProperty	(	resqml2::AbstractRepresentation *	rep,
		const std::string &	guid,
		const std::string &	title,
		unsigned int	dimension,
		gsoap_eml2_3::resqml22__IndexableElement	attachmentKind,
		resqml2::DoubleTableLookup *	dblLookup,
		eml2::PropertyKind *	localPropKind
	)

Creates a categorical property.

Exceptions

std::invalid_argument

If rep, strLookup or propKind is null. If dimension is zero.

Parameters

[in]	rep	The representation on which this property is attached to. It cannot be null.
	guid	The guid to set to the property. If empty then a new guid will be generated.
	title	The title to set to the property. If empty then "unknown" title will be set.
	dimension	The dimension of each value of this property. Dimension is 1 for a scalar property.
	attachmentKind	The topological element on which the property values are attached to.
[in]	dblLookup	The double table lookup which associate a discrete function to the property values.
[in]	localPropKind	The property kind of these property values. It cannot be null.

CategoricalProperty() [4/4]

resqml2_2::CategoricalProperty::CategoricalProperty ( gsoap_eml2_3::_resqml22__CategoricalProperty *  fromGsoap )

inline

Creates an instance of this class by wrapping a gSOAP instance

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

~CategoricalProperty()

resqml2_2::CategoricalProperty::~CategoricalProperty ( )

virtualdefault

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

Reimplemented from resqml2::CategoricalProperty.

Member Function Documentation

getLookupDor()

common::DataObjectReference resqml2_2::CategoricalProperty::getLookupDor ( ) const

finalvirtual

Gets the DOR of the lookup which is associated to this categorical property values.

Returns

The DOR of the lookup which is associated to this categorical property.

Implements resqml2::CategoricalProperty.

getXmlNamespace()

std::string resqml2_2::CategoricalProperty::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

validatePropertyKindAssociation() [1/2]

bool resqml2_2::CategoricalProperty::validatePropertyKindAssociation ( eml2::PropertyKind *  pk )

inlinefinalvirtual

Checks if it is allowed to associate a given property kind to this property.

Parameters

[in]

pk

The local property kind to check.

Returns

True if it is allowed, false if it is not.

Implements resqml2::AbstractProperty.

validatePropertyKindAssociation() [2/2]

bool resqml2_2::CategoricalProperty::validatePropertyKindAssociation ( gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind  pk )

inlinefinalvirtual

Checks if it is allowed to associate a given standard Energistics property kind to this property.

Parameters

pk	The standard Energistics property kind to check.

Returns

True if it is allowed, false if it is not.

Implements resqml2::AbstractProperty.

Member Data Documentation

XML_NS

const char* resqml2_2::CategoricalProperty::XML_NS

static

The standard XML namespace for serializing this data object.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2_2/CategoricalProperty.h