My Project
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::DiscreteProperty Class Reference
Inheritance diagram for resqml2_0_1::DiscreteProperty:
resqml2::AbstractValuesProperty resqml2::AbstractProperty resqml2::AbstractObject resqml2_0_1::DiscretePropertySeries

Public Member Functions

 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, resqml2::AbstractHdfProxy *proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)
 
void pushBackLongHdf5Array1dOfValues (long *values, const ULONG64 &valueCount, resqml2::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackIntHdf5Array1dOfValues (int *values, const ULONG64 &valueCount, resqml2::AbstractHdfProxy *proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)
 
void pushBackIntHdf5Array1dOfValues (int *values, const ULONG64 &valueCount, resqml2::AbstractHdfProxy *proxy, const int &nullValue)
 
void pushBackLongHdf5Array2dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)
 
void pushBackLongHdf5Array2dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackIntHdf5Array2dOfValues (int *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)
 
void pushBackIntHdf5Array2dOfValues (int *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const int &nullValue)
 
void pushBackLongHdf5Array3dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)
 
void pushBackLongHdf5Array3dOfValues (long *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackIntHdf5Array3dOfValues (int *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)
 
void pushBackIntHdf5Array3dOfValues (int *values, const ULONG64 &valueCountInFastestDim, const ULONG64 &valueCountInMiddleDim, const ULONG64 &valueCountInSlowestDim, resqml2::AbstractHdfProxy *proxy, const int &nullValue)
 
void pushBackLongHdf5ArrayOfValues (long *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, resqml2::AbstractHdfProxy *proxy, const long &nullValue, const long &minimumValue, const long &maximumValue)
 
void pushBackLongHdf5ArrayOfValues (long *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, resqml2::AbstractHdfProxy *proxy, const long &nullValue)
 
void pushBackIntHdf5ArrayOfValues (int *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, resqml2::AbstractHdfProxy *proxy, const int &nullValue, const int &minimumValue, const int &maximumValue)
 
void pushBackIntHdf5ArrayOfValues (int *values, unsigned long long *numValues, const unsigned int &numDimensionsInArray, resqml2::AbstractHdfProxy *proxy, const int &nullValue)
 
gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind getFirstAllowedPropertyKindParent () const
 
- Public Member Functions inherited from resqml2::AbstractValuesProperty
 AbstractValuesProperty ()
 
 AbstractValuesProperty (gsoap_resqml2_0_1::resqml2__AbstractValuesProperty *fromGsoap)
 
virtual ~AbstractValuesProperty ()
 
unsigned int getPatchCount () const
 
AbstractValuesProperty::hdfDatatypeEnum getValuesHdfDatatype () const
 
void pushBackRefToExistingDataset (resqml2::AbstractHdfProxy *hdfProxy, const bool &isAnIntegerDataset, const std::string &dataset="")
 
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)
 
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, resqml2::AbstractHdfProxy *proxy)
 
void createLongHdf5Array3dOfValues (const unsigned int &valueCountInFastestDim, const unsigned int &valueCountInMiddleDim, const unsigned int &valueCountInSlowestDim, resqml2::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, resqml2::AbstractHdfProxy *proxy)
 
void pushBackLongHdf5SlabArrayOfValues (long *values, unsigned long long *numValues, unsigned long long *offsetValues, const unsigned int &numArrayDimensions, resqml2::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 ()
 
 AbstractProperty (gsoap_resqml2_0_1::resqml2__AbstractProperty *fromGsoap)
 
virtual ~AbstractProperty ()
 
void setRepresentation (class AbstractRepresentation *rep)
 
class AbstractRepresentation * getRepresentation () const
 
std::string getRepresentationUuid () const
 
std::string getRepresentationTitle () const
 
std::string getRepresentationContentType () const
 
void setTimeSeries (class TimeSeries *ts)
 
TimeSeries * getTimeSeries () 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 (AbstractHdfProxy *proxy)
 
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)
 
std::string getLocalPropertyKindUuid () const
 
std::string getLocalPropertyKindTitle () const
 
class PropertyKind * getLocalPropertyKind () const
 
- Public Member Functions inherited from resqml2::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::eml__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml__DataObjectReference * newResqmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
common::EpcDocument * getEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
std::string getContentType () const
 
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
 
void addOrSetExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::string getExtraMetadata (const std::string &key)
 
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 Member Functions inherited from resqml2::AbstractValuesProperty
std::string getPathInHdfFileOfPatch (const unsigned int &patchIndex, LONG64 &nullValue) const
 
- 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 resqml2::AbstractObject
 AbstractObject (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API. More...
 
 AbstractObject (gsoap_resqml2_0_1::eml__AbstractCitedDataObject *proxy=nullptr)
 
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)
 
- Static Protected Member Functions inherited from resqml2::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from resqml2::AbstractProperty
class AbstractLocal3dCrs * local3dCrs
 
- Protected Attributes inherited from resqml2::AbstractObject
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * gsoapProxy2_0_1
 
common::EpcDocument * epcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

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

gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind DiscreteProperty::getFirstAllowedPropertyKindParent ( ) const
virtual

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

Reimplemented from resqml2::AbstractProperty.

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

Get the XML tag for the XML serialization of this instance

Implements resqml2::AbstractObject.

Reimplemented in resqml2_0_1::DiscretePropertySeries.

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

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

Parameters
valuesAll the property values to set ordered according 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.
minimumValueThe minimum value of the values to add. If not provided then the minimum value will be computed from the values.
maximumValueThe 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,
resqml2::AbstractHdfProxy *  proxy,
const long &  nullValue,
const long &  minimumValue,
const long &  maximumValue 
)

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

Parameters
valuesAll the property values to set ordered according 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.
minimumValueThe minimum value of the values to add. If not provided then the minimum value will be computed from the values.
maximumValueThe 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,
resqml2::AbstractHdfProxy *  proxy,
const long &  nullValue,
const long &  minimumValue,
const long &  maximumValue 
)

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

Parameters
valuesAll the property values to set ordered according 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.
minimumValueThe minimum value of the values to add. If not provided then the minimum value will be computed from the values.
maximumValueThe 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,
resqml2::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
valuesAll the property values to set ordered according 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.
minimumValueThe minimum value of the values to add. If not provided then the minimum value will be computed from the values.
maximumValueThe maximum value of the values to add. If not provided then the maximum value will be computed from the values.
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11