Fesapi 2.10.1.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2::CommentProperty Class Referenceabstract

Proxy class for a comment property. It is used to capture comments or annotations associated with a given element type in a data-object, for example, associating comments on the specific location of a well path. More...

#include <CommentProperty.h>

Inheritance diagram for resqml2::CommentProperty:
resqml2::AbstractValuesProperty resqml2::AbstractProperty common::AbstractObject resqml2_0_1::CommentProperty resqml2_2::CommentProperty

Public Member Functions

virtual ~CommentProperty ()=default
 
std::string pushBackRefToExistingIntegerDataset (eml2::AbstractHdfProxy *, const std::string &, int64_t) final
 
void pushBackStringHdf5ArrayOfValues (const std::vector< std::string > &values, eml2::AbstractHdfProxy *proxy)
 
virtual std::string pushBackRefToExistingDataset (eml2::AbstractHdfProxy *hdfProxy, const std::string &datasetName="")=0
 
std::vector< std::string > getStringValuesOfPatch (unsigned int patchIndex)
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::AbstractValuesProperty
virtual ~AbstractValuesProperty ()=default
 
uint64_t getPatchCount () const final
 
common::AbstractObject::numericalDatatypeEnum getValuesHdfDatatype () const final
 
uint64_t getValuesCountOfDimensionOfPatch (uint64_t dimIndex, uint64_t patchIndex) const final
 
uint64_t getDimensionsCountOfPatch (uint64_t patchIndex) const final
 
void pushBackFacet (gsoap_eml2_3::eml23__FacetKind facet, const std::string &facetValue)
 
uint64_t getFacetCount () const
 
gsoap_eml2_3::eml23__FacetKind getFacetKind (uint64_t index) const
 
std::string getFacetValue (uint64_t index) const
 
void pushBackIntegerConstantArrayOfValues (int64_t value, uint64_t valueCount)
 Adds an array constant integer values to the property values.
 
void pushBackInt64Hdf5Array1dOfValues (const int64_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 1d array of explicit int values to the property values.
 
void pushBackInt32Hdf5Array1dOfValues (const int *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array1dOfValues (const short *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackInt8Hdf5Array1dOfValues (const int8_t *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy, int8_t nullValue)
 
void pushBackInt64Hdf5Array2dOfValues (const int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds a 2d array of explicit int values to the property values.
 
void pushBackInt32Hdf5Array2dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array2dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUInt16Hdf5Array2dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackInt8Hdf5Array2dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int8_t nullValue)
 
void pushBackInt64Hdf5Array3dOfValues (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 int values to the property values.
 
void pushBackInt32Hdf5Array3dOfValues (const int *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int nullValue)
 
void pushBackInt16Hdf5Array3dOfValues (const short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, short nullValue)
 
void pushBackUInt16Hdf5Array3dOfValues (const unsigned short *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
void pushBackInt8Hdf5Array3dOfValues (const int8_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, eml2::AbstractHdfProxy *proxy, int8_t nullValue)
 
virtual void pushBackInt64Hdf5ArrayOfValues (const int64_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int64_t nullValue)
 Adds an nd array of explicit int values to the property values.
 
virtual void pushBackInt32Hdf5ArrayOfValues (const int *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int nullValue)
 
virtual void pushBackInt16Hdf5ArrayOfValues (const short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, short nullValue)
 
virtual void pushBackUInt16Hdf5ArrayOfValues (const unsigned short *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, unsigned short nullValue)
 
virtual void pushBackInt8Hdf5ArrayOfValues (const int8_t *values, const uint64_t *numValues, unsigned int numDimensionsInArray, eml2::AbstractHdfProxy *proxy, int8_t nullValue)
 
bool hasConstantValues (uint64_t patchIndex) const
 
int64_t getInt64ConstantValuesOfPatch (uint64_t patchIndex) const
 
double getDoubleConstantValuesOfPatch (uint64_t patchIndex) const
 
int64_t getNullValueOfPatch (uint64_t patchIndex) const
 
int64_t getInt64ValuesOfPatch (uint64_t patchIndex, int64_t *values) const
 
uint64_t getUInt64ValuesOfPatch (uint64_t patchIndex, uint64_t *values) const
 
int32_t getInt32ValuesOfPatch (uint64_t patchIndex, int32_t *values) const
 
uint32_t getUInt32ValuesOfPatch (uint64_t patchIndex, uint32_t *values) const
 
int16_t getInt16ValuesOfPatch (uint64_t patchIndex, int16_t *values) const
 
uint16_t getUInt16ValuesOfPatch (uint64_t patchIndex, uint16_t *values) const
 
int8_t getInt8ValuesOfPatch (uint64_t patchIndex, int8_t *values) const
 
uint8_t getUInt8ValuesOfPatch (uint64_t patchIndex, uint8_t *values) const
 
void pushBackHdf5ArrayOfValues (common::AbstractObject::numericalDatatypeEnum datatype, uint64_t const *numValues, unsigned int numArrayDimensions, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array1dOfValues (common::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCount, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array2dOfValues (common::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void pushBackHdf5Array3dOfValues (common::AbstractObject::numericalDatatypeEnum datatype, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, int64_t nullValue=(std::numeric_limits< int64_t >::max)(), eml2::AbstractHdfProxy *proxy=nullptr)
 
void setValuesOfInt64Hdf5ArrayOfValues (int64_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5ArrayOfValues (uint64_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5ArrayOfValues (int32_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5ArrayOfValues (uint32_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5ArrayOfValues (int16_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5ArrayOfValues (uint16_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5ArrayOfValues (int8_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5ArrayOfValues (uint8_t const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5ArrayOfValues (float const *values, uint64_t const *numValues, uint64_t const *offsetValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array1dOfValues (int64_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array1dOfValues (uint64_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array1dOfValues (int32_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array1dOfValues (uint32_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array1dOfValues (int16_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array1dOfValues (uint16_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array1dOfValues (int8_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array1dOfValues (uint8_t const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array1dOfValues (double const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5Array1dOfValues (float const *values, uint64_t valueCount, uint64_t offset, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array2dOfValues (int64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array2dOfValues (uint64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array2dOfValues (int32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array2dOfValues (uint32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array2dOfValues (int16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array2dOfValues (uint16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array2dOfValues (int8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array2dOfValues (uint8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array2dOfValues (double const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfFloatHdf5Array2dOfValues (float const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt64Hdf5Array3dOfValues (int64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt64Hdf5Array3dOfValues (uint64_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt32Hdf5Array3dOfValues (int32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt32Hdf5Array3dOfValues (uint32_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt16Hdf5Array3dOfValues (int16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt16Hdf5Array3dOfValues (uint16_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfInt8Hdf5Array3dOfValues (int8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfUInt8Hdf5Array3dOfValues (uint8_t const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void setValuesOfDoubleHdf5Array3dOfValues (double const *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim, eml2::AbstractHdfProxy *proxy=nullptr, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
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, uint64_t patchIndex=(std::numeric_limits< uint64_t >::max)())
 
void getInt64ValuesOfPatch (uint64_t patchIndex, int64_t *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getInt64ValuesOf3dPatch (uint64_t patchIndex, int64_t *values, uint64_t valueCountInFastestDim, uint64_t valueCountInMiddleDim, uint64_t valueCountInSlowestDim, uint64_t offsetInFastestDim, uint64_t offsetInMiddleDim, uint64_t offsetInSlowestDim) const
 
int32_t getIntValuesOfPatch (uint64_t patchIndex, int32_t *values, const uint64_t *numValuesInEachDimension, const uint64_t *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getIntValuesOf3dPatch (uint64_t patchIndex, int32_t *values, unsigned int valueCountInFastestDim, unsigned int valueCountInMiddleDim, unsigned int valueCountInSlowestDim, unsigned int offsetInFastestDim, unsigned int offsetInMiddleDim, unsigned int offsetInSlowestDim) const
 
void pushBackFloatingPointConstantArrayOfValues (double value, uint64_t valueCount)
 Adds an array constant flaoting point values to the property values.
 
void pushBackDoubleHdf5Array1dOfValues (const double *values, uint64_t valueCount, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds a 1d array of explicit double values to the property values.
 
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.
 
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.
 
void pushBackDoubleHdf5ArrayOfValues (double const *values, uint64_t const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
 Adds an nd array of explicit double values to the property values.
 
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, uint64_t const *numValues, unsigned int numArrayDimensions, eml2::AbstractHdfProxy *proxy=nullptr)
 
virtual std::string pushBackRefToExistingFloatingPointDataset (eml2::AbstractHdfProxy *proxy, const std::string &datasetName="")
 
void getDoubleValuesOfPatch (uint64_t patchIndex, double *values) const
 
void getFloatValuesOfPatch (uint64_t patchIndex, float *values) const
 
void getFloatValuesOfPatch (uint64_t patchIndex, float *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numArrayDimensions) const
 
void getFloatValuesOf3dPatch (uint64_t 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::eml23__IndexableElement getAttachmentKind () const
 
uint64_t getValuesCountOfPatch (unsigned int patchIndex) const
 
std::vector< resqml2_0_1::PropertySet * > getPropertySets () const
 
uint64_t getPropertySetCount () const
 
resqml2_0_1::PropertySet * getPropertySet (uint64_t index) const
 
void setLocalCrs (eml2::AbstractLocal3dCrs *crs)
 
eml2::AbstractLocal3dCrs * getLocalCrs () const
 
common::DataObjectReference getLocalCrsDor () const
 
bool hasRealizationIndices () const
 
std::vector< unsigned int > getRealizationIndices () const
 
void setRealizationIndices (int64_t startRealizationIndex, int64_t countRealizationIndices)
 
void setRealizationIndices (const std::vector< unsigned int > &realizationIndices, eml2::AbstractHdfProxy *hdfProxy=nullptr)
 Sets the realization indices of this property.
 
void setTimeSeries (eml2::TimeSeries *ts)
 
void setSingleTimestamp (time_t timestamp, LONG64 yearOffset=0)
 
time_t getSingleTimestamp () const
 
eml2::TimeSeries * getTimeSeries () const
 
common::DataObjectReference getTimeSeriesDor () 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
 
virtual bool validatePropertyKindAssociation (eml2::PropertyKind *pk)=0
 
virtual bool validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk)=0
 
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)
 
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
 
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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 getXmlNamespace () const =0
 
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)
 
uint64_t getAliasCount () const
 
std::string getAliasAuthorityAtIndex (uint64_t index) const
 
std::string getAliasTitleAtIndex (uint64_t index) const
 
std::vector< eml2::Activity * > getActivitySet () const
 
uint64_t getActivityCount () const
 
eml2::Activity * getActivity (uint64_t 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
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 

Static Public Attributes

static constexpr char const * XML_TAG = "CommentProperty"
 

Additional Inherited Members

- Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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 comment property. It is used to capture comments or annotations associated with a given element type in a data-object, for example, associating comments on the specific location of a well path.

Constructor & Destructor Documentation

◆ ~CommentProperty()

virtual resqml2::CommentProperty::~CommentProperty ( )
virtualdefault

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

Reimplemented in resqml2_0_1::CommentProperty, and resqml2_2::CommentProperty.

Member Function Documentation

◆ getStringValuesOfPatch()

std::vector< std::string > resqml2::CommentProperty::getStringValuesOfPatch ( unsigned int patchIndex)

Gets all the values of a given patch of this instance. Values are supposed to be string ones.

Exceptions
std::out_of_rangeIf patchIndex is strictly greater than patch count.
Parameters
patchIndexThe index of the patch we want the values from.
Returns
The string values of the patch.

◆ getXmlTag()

virtual std::string resqml2::CommentProperty::getXmlTag ( ) const
inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

Implements common::AbstractObject.

◆ pushBackRefToExistingDataset()

virtual std::string resqml2::CommentProperty::pushBackRefToExistingDataset ( eml2::AbstractHdfProxy * hdfProxy,
const std::string & datasetName = "" )
pure virtual

Pushes back a new patch of values for this property where the values have not to be written in the HDF5 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 differed in time.

Exceptions
std::invalid_argumentIf hdfProxy is null.
Parameters
[in]hdfProxyThe HDF5 proxy where the values are already or will be stored. It cannot be null.
datasetName(Optional) If not provided during the method call, the dataset will be named the same as the dataset naming convention of fesapi: "/RESQML/" + prop->uuid + "/values_patch" + patchIndex
nullValue(Optional) Not used for comment properties.
Returns
The name of the HDF5 dataset.

Implemented in resqml2_0_1::CommentProperty, and resqml2_2::CommentProperty.

◆ pushBackRefToExistingIntegerDataset()

std::string resqml2::CommentProperty::pushBackRefToExistingIntegerDataset ( eml2::AbstractHdfProxy * ,
const std::string & ,
int64_t  )
inlinefinalvirtual

Please use std::string pushBackRefToExistingDataset(EML2_NS::AbstractHdfProxy* hdfProxy, const std::string & datasetName = "") instead. Notice the lack of null value parameter.

Reimplemented from resqml2::AbstractValuesProperty.

◆ pushBackStringHdf5ArrayOfValues()

void resqml2::CommentProperty::pushBackStringHdf5ArrayOfValues ( const std::vector< std::string > & values,
eml2::AbstractHdfProxy * proxy )

Adds an array of string values to the property values.

Parameters
valuesAll the property values to set ordered according the topology of the representation it is based on.
[in]proxyThe HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If null then a default HDF proxy must be defined in the data object repository.

Member Data Documentation

◆ XML_TAG

char const* resqml2::CommentProperty::XML_TAG = "CommentProperty"
staticconstexpr

The standard XML tag without XML namespace for serializing this data object

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0