Fesapi  0.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
RESQML2_0_1_NS::CategoricalProperty Class Reference
Inheritance diagram for RESQML2_0_1_NS::CategoricalProperty:
RESQML2_NS::AbstractValuesProperty RESQML2_NS::AbstractProperty COMMON_NS::AbstractObject RESQML2_0_1_NS::CategoricalPropertySeries

Public Member Functions

 CategoricalProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 CategoricalProperty (StringTableLookup *strLookup)
 
 CategoricalProperty (RESQML2_NS::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_NS::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_NS::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_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackLongHdf5Array2dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackLongHdf5Array3dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackLongHdf5ArrayOfValues (long *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackUShortHdf5Array1dOfValues (unsigned short *values, const ULONG64 &valueCount, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackUShortHdf5Array2dOfValues (unsigned short *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackUShortHdf5Array3dOfValues (unsigned short *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, COMMON_NS::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackUShortHdf5ArrayOfValues (unsigned short *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, COMMON_NS::AbstractHdfProxy *proxy, const unsigned short &nullValue)
 
std::string pushBackRefToExistingDataset (COMMON_NS::AbstractHdfProxy *hdfProxy, const std::string &dataset="", const long &nullValue=(std::numeric_limits< long >::max)())
 
class StringTableLookupgetStringLookup ()
 
std::string getStringLookupUuid () const
 
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 AbstractRepresentationgetRepresentation () const
 
std::string getRepresentationUuid () const
 
std::string getRepresentationTitle () const
 
std::string getRepresentationContentType () const
 
void setTimeSeries (class TimeSeries *ts)
 
TimeSeriesgetTimeSeries () 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::AbstractHdfProxygetHdfProxy () 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 PropertyKindgetLocalPropertyKind () 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::EpcDocumentgetEpcDocument () 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::ActivitygetActivity (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::RelationshipgetAllEpcRelationships () const
 
virtual void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- 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)
 
- 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 ()
 

Protected Attributes

class StringTableLookupstringLookup
 
- Protected Attributes inherited from RESQML2_NS::AbstractProperty
class AbstractLocal3dCrslocal3dCrs
 
- 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::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

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)
 

Constructor & Destructor Documentation

RESQML2_0_1_NS::CategoricalProperty::CategoricalProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

RESQML2_0_1_NS::CategoricalProperty::CategoricalProperty ( RESQML2_NS::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
repThe representation which supports these property values.
guidThe guid to set to the fault. If empty then a new guid will be generated.
titleA title for the instance to create.
dimensionThe dimension of each value (scalar properties == 1).
attachmentKindThe topological orbit which support each value.
strLookupThe string lookup which defines the possible string values and their keys.
energisticsPropertyKindThe property kind of these property values which must be defined in the standard energistics property type dictionary.
RESQML2_0_1_NS::CategoricalProperty::CategoricalProperty ( RESQML2_NS::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_NS::PropertyKind localPropKind 
)

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

Parameters
repThe representation which supports these property values.
guidThe guid to set to the fault. If empty then a new guid will be generated.
titleA title for the instance to create.
dimensionThe dimension of each value (scalar properties == 1).
attachmentKindThe topological orbit which support each value.
strLookupThe string lookup which defines the possible string values and their keys.
localPropKindThe property kind of these property values which must be defined in the EPC document as a local property kind.
RESQML2_0_1_NS::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_NS::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_NS::AbstractProperty.

class StringTableLookup* RESQML2_0_1_NS::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_NS::CategoricalProperty::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

Reimplemented in RESQML2_0_1_NS::CategoricalPropertySeries.

void CategoricalProperty::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument epcDoc)
protectedvirtual

Resolve all relationships of the object in an epc document

Reimplemented from RESQML2_NS::AbstractProperty.

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

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountThe number of values to write.
proxyThe 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_NS::AbstractHdfProxy proxy,
const long &  nullValue 
)

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
proxyThe 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_NS::AbstractHdfProxy proxy,
const long &  nullValue 
)

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
proxyThe 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_NS::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
valuesAll the property values to set ordered according to the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numDimensionsInArrayThe number of dimensions in the array to write.
proxyThe 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_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
hdfProxyThe HDF5 proxy where the values are already or will be stored.
datasetNameIf 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;
nullValueOnly 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_NS::AbstractValuesProperty.

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

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountThe number of values to write.
proxyThe 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_NS::AbstractHdfProxy proxy,
const long &  nullValue 
)

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly J dimension).
proxyThe 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_NS::AbstractHdfProxy proxy,
const long &  nullValue 
)

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

Parameters
valuesAll the property values to set ordered according to the topology of the representation it is based on.
valueCountInFastestDimThe number of values to write in the fastest dimension (mainly I dimension).
valueCountInMiddleDimThe number of values to write in the middle dimension (mainly J dimension).
valueCountInSlowestDimThe number of values to write in the slowest dimension (mainly K dimension).
proxyThe 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_NS::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
valuesAll the property values to set ordered according to the topology of the representation it is based on.
numValuesThe number of property values ordered by dimension of the array to write.
numDimensionsInArrayThe number of dimensions in the array to write.
proxyThe 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_NS::PropertyKind pk)
virtual

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

Implements RESQML2_NS::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_NS::AbstractProperty.


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