Fesapi
2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
Proxy class for an abstract values property. More...
#include <AbstractValuesProperty.h>
Public Member Functions | |
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 |
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) |
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 | getXmlNamespace () const =0 |
virtual std::string | getXmlTag () 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) |
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 |
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) |
Proxy class for an abstract values property.
|
virtualdefault |
Destructor does nothing since the memory is managed by the gsoap context.
char resqml2::AbstractValuesProperty::getCharValuesOfPatch | ( | unsigned int | patchIndex, |
char * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be char ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
void resqml2::AbstractValuesProperty::getDoubleValuesOfPatch | ( | unsigned int | patchIndex, |
double * | values | ||
) | const |
Gets all the values of a particular patch of this instance which are supposed to be double ones.
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) . |
unsigned int resqml2::AbstractValuesProperty::getFacetCount | ( | ) | const |
Gets the count of facet of this instance
gsoap_eml2_3::eml23__FacetKind resqml2::AbstractValuesProperty::getFacetKind | ( | unsigned int | index | ) | const |
Gets the facet at a particular index of the facet collection of this instance.
std::out_of_range | If index is strictly greater than facet count. |
index | Zero-based index of the facet we want to get. |
index
. std::string resqml2::AbstractValuesProperty::getFacetValue | ( | unsigned int | index | ) | const |
Gets the facet value at a particular index of the facet collection of this instance.
std::out_of_range | If index is strictly greater than facet count. |
index | Zero-based index of the facet we want to get. |
index
. void resqml2::AbstractValuesProperty::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 |
Get some of the values of a particular patch of the instance as float ones. This method makes use of HDF5 hyperslabbing.
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[in,out] | values | The array (pointer) of values must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
valueCountInFastestDim | The number of values to read in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to read in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to read in the slowest dimension (mainly K dimension). | |
offsetInFastestDim | The offset value for reading in the fastest dimension (mainly I dimension). | |
offsetInMiddleDim | The offset value for reading in the middle dimension (mainly J dimension). | |
offsetInSlowestDim | The offset value for reading in the slowest dimension (mainly K dimension). |
void resqml2::AbstractValuesProperty::getFloatValuesOfPatch | ( | unsigned int | patchIndex, |
float * | values | ||
) | const |
Gets all the values of a particular patch of this instance which are supposed to be float ones.
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) . |
void resqml2::AbstractValuesProperty::getFloatValuesOfPatch | ( | unsigned int | patchIndex, |
float * | values, | ||
unsigned long long const * | numValuesInEachDimension, | ||
unsigned long long const * | offsetInEachDimension, | ||
unsigned int | numArrayDimensions | ||
) | const |
Get some of the values of a particular patch of the instance as float ones. This method makes use of HDF5 hyperslabbing.
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | The array (pointer) of values must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
numValuesInEachDimension | The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. | |
offsetInEachDimension | The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. | |
numArrayDimensions | The number of dimensions of the HDF5 array to read. |
void resqml2::AbstractValuesProperty::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 |
Gets some of the values of a given patch of this instance. Values are supposed to be integer ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | The array (pointer) of values must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
valueCountInFastestDim | The number of values to read in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to read in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to read in the slowest dimension (mainly K dimension). | |
offsetInFastestDim | The offset value for reading in the fastest dimension (mainly I dimension). | |
offsetInMiddleDim | The offset value for reading in the middle dimension (mainly J dimension). | |
offsetInSlowestDim | The offset value for reading in the slowest dimension (mainly K dimension). |
int resqml2::AbstractValuesProperty::getIntValuesOfPatch | ( | unsigned int | patchIndex, |
int * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be integer ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
int resqml2::AbstractValuesProperty::getIntValuesOfPatch | ( | unsigned int | patchIndex, |
int * | values, | ||
unsigned long long * | numValuesInEachDimension, | ||
unsigned long long * | offsetInEachDimension, | ||
unsigned int | numArrayDimensions | ||
) | const |
Gets some of the values of a given patch of this instance. Values are supposed to be integer ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | The array (pointer) of values which must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
[in] | numValuesInEachDimension | The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. |
[in] | offsetInEachDimension | The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. |
numArrayDimensions | The number of dimensions of the array to read. |
void resqml2::AbstractValuesProperty::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 |
Gets some of the values of a given patch of this instance. Values are supposed to be long 64 bits ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | The array (pointer) of values must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
valueCountInFastestDim | The number of values to read in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to read in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to read in the slowest dimension (mainly K dimension). | |
offsetInFastestDim | The offset value for reading in the fastest dimension (mainly I dimension). | |
offsetInMiddleDim | The offset value for reading in the middle dimension (mainly J dimension). | |
offsetInSlowestDim | The offset value for reading in the slowest dimension (mainly K dimension). |
int64_t resqml2::AbstractValuesProperty::getLongValuesOfPatch | ( | unsigned int | patchIndex, |
int64_t * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be long ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) . |
void resqml2::AbstractValuesProperty::getLongValuesOfPatch | ( | unsigned int | patchIndex, |
int64_t * | values, | ||
unsigned long long const * | numValuesInEachDimension, | ||
unsigned long long const * | offsetInEachDimension, | ||
unsigned int | numArrayDimensions | ||
) | const |
Gets some of the values of a given patch of this instance. Values are supposed to be long 64 bits ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | The array (pointer) of values which must be preallocated. Size is getValuesCountOfPatch(patchIndex) . |
numValuesInEachDimension | The number of property values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. | |
offsetInEachDimension | The offset values ordered by dimension of the array to read. It is ordered from slowest dimension to fastest dimension. | |
numArrayDimensions | The number of dimensions of the array to write. |
int64_t resqml2::AbstractValuesProperty::getNullValueOfPatch | ( | unsigned int | patchIndex | ) | const |
Gets the null value of a given patch of this instance. Values are supposed to be integer ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::range_error | If patchIndex is strictly greater than patch count. |
std::invalid_argument | If the patchIndex patch does not contain integer values. |
patchIndex | The index of the patch we want the values from. |
|
finalvirtual |
Gets the number of patches in this values property. It should be the same count as the patch count of the associated representation.
std::out_of_range | If the patch count is strictly greater than unsigned int max value. |
Implements resqml2::AbstractProperty.
short resqml2::AbstractValuesProperty::getShortValuesOfPatch | ( | unsigned int | patchIndex, |
short * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be short ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
unsigned char resqml2::AbstractValuesProperty::getUCharValuesOfPatch | ( | unsigned int | patchIndex, |
unsigned char * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be unsigned char ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
unsigned int resqml2::AbstractValuesProperty::getUIntValuesOfPatch | ( | unsigned int | patchIndex, |
unsigned int * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be unsigned integer ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
uint64_t resqml2::AbstractValuesProperty::getULongValuesOfPatch | ( | unsigned int | patchIndex, |
uint64_t * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be unsigned long ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
unsigned short resqml2::AbstractValuesProperty::getUShortValuesOfPatch | ( | unsigned int | patchIndex, |
unsigned short * | values | ||
) | const |
Gets all the values of a given patch of this instance. Values are supposed to be unsigned short ones.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::out_of_range | If patchIndex is strictly greater than patch count. |
patchIndex | The index of the patch we want the values from. | |
[out] | values | Preallocated buffer for receiving the values. Size is getValuesCountOfPatch(patchIndex) |
void resqml2::AbstractValuesProperty::pushBackCharHdf5Array1dOfValues | ( | const char * | values, |
uint64_t | valueCount, | ||
eml2::AbstractHdfProxy * | proxy, | ||
char | nullValue | ||
) |
Adds a 1d array of explicit char values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackCharHdf5Array2dOfValues | ( | const char * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
char | nullValue | ||
) |
Adds a 2d array of explicit char values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackCharHdf5Array3dOfValues | ( | const char * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
char | nullValue | ||
) |
Adds a 3d array of explicit char values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
|
virtual |
Adds an nd array of explicit char values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
[in] | numValues | The number of property values ordered by dimension of the array to write. |
numDimensionsInArray | The number of dimensions in the array to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
Reimplemented in resqml2::DiscreteProperty.
void resqml2::AbstractValuesProperty::pushBackDoubleHdf5Array1dOfValues | ( | const double * | values, |
uint64_t | valueCount, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Adds a 1d array of explicit double values to the property values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::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.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::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.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::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.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
numValues | The number of property values ordered by dimension of the array to write. | |
numArrayDimensions | The number of dimensions of the array to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::pushBackFacet | ( | gsoap_eml2_3::eml23__FacetKind | facet, |
const std::string & | facetValue | ||
) |
Pushes back a new facet to this instance. Facets are qualifiers for property values which allow users to semantically specialize a property without creating a new property kind.
facet | The facet. |
facetValue | The facet value. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array1dOfValues | ( | const float * | values, |
uint64_t | valueCount, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Adds a 1d array of explicit float values to the property values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array2dOfValues | ( | const float * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Adds a 2d array of explicit float values to the property values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array3dOfValues | ( | const float * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Adds a 3d array of explicit float values to the property values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5Array3dOfValues | ( | uint64_t | valueCountInFastestDim, |
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Creates a 3d array of explicit float values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5ArrayOfValues | ( | float const * | values, |
unsigned long long const * | numValues, | ||
unsigned int | numArrayDimensions, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Adds an nd array of explicit float values to the property values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
numValues | The number of property values ordered by dimension of the array to write. | |
numArrayDimensions | The number of dimensions of the array to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), then a default HDF proxy must be defined in the repository. |
void resqml2::AbstractValuesProperty::pushBackFloatHdf5ArrayOfValues | ( | unsigned long long const * | numValues, |
unsigned int | numArrayDimensions, | ||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Create an nd array of explicit float values to the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
numValues | The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. | |
numArrayDimensions | The number of dimensions of the array to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository. |
void resqml2::AbstractValuesProperty::pushBackIntHdf5Array1dOfValues | ( | const int * | values, |
uint64_t | valueCount, | ||
eml2::AbstractHdfProxy * | proxy, | ||
int | nullValue | ||
) |
Adds a 1d array of explicit integer values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackIntHdf5Array2dOfValues | ( | const int * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
int | nullValue | ||
) |
Adds a 2d array of explicit integer values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackIntHdf5Array3dOfValues | ( | const int * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
int | nullValue | ||
) |
Adds a 3d array of explicit integer values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
|
virtual |
Adds an nd array of explicit integer values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
[in] | numValues | The number of property values ordered by dimension of the array to write. |
numDimensionsInArray | The number of dimensions in the array to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
Reimplemented in resqml2::DiscreteProperty.
void resqml2::AbstractValuesProperty::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.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::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.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::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.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackLongHdf5Array3dOfValues | ( | uint64_t | valueCountInFastestDim, |
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
int64_t | nullValue = (std::numeric_limits< int64_t >::max)() , |
||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Creates a 3d array of explicit long 64 values into the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
valueCountInFastestDim | The number of values in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values in the slowest dimension (mainly K dimension). | |
nullValue | (Optional) The null value. Default value is long 64 bits maximum value. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), a default HDF proxy must be defined into the data object repository. |
|
virtual |
Adds an nd array of explicit long values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
[in] | numValues | The number of property values ordered by dimension of the array to write. |
numDimensionsInArray | The number of dimensions in the array to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
Reimplemented in resqml2::DiscreteProperty.
void resqml2::AbstractValuesProperty::pushBackLongHdf5ArrayOfValues | ( | unsigned long long * | numValues, |
unsigned int | numArrayDimensions, | ||
int64_t | nullValue = (std::numeric_limits< int64_t >::max)() , |
||
eml2::AbstractHdfProxy * | proxy = nullptr |
||
) |
Creates an nd array of explicit long 64 bits values into the property values. No values are written to this array yet then the HDF5 array contains uninitialized values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
[in] | numValues | The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. |
numArrayDimensions | The number of dimensions of the array to write. | |
nullValue | (Optional) The null value. Default value is long 64 bits maximum value. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), a default HDF proxy must be defined into the data object repository. |
|
virtual |
Pushes back a reference to an existing (or a "to exist") HDF dataset in a particular HDF proxy. 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.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
[in] | proxy | The HDF5 proxy where the values are already or will be stored. If nullptr , then a default HDF proxy must be defined in the repository. |
datasetName | (Optional) The HDF5 dataset name where the values are stored. If empty, the dataset will be named the same as the dataset naming convention of fesapi : getHdfGroup() + "/values_patch" + patchIndex |
|
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.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If hdfProxy is nullptr and no default HDF proxy is defined in the repository. |
[in] | hdfProxy | The HDF5 proxy where the values are already or will be stored. If nullptr , then a default HDF proxy must be defined in the repository. |
dataset | (Optional) If not provided during the method call, the dataset will be named the same as the dataset naming convention of fesapi : getHdfGroup() + "/values_patch" + patchIndex | |
nullValue | (Optional) Only relevant for integer HDF5 datasets. Indeed, RESQML (and fesapi) forces null value for floating point to be NaN value. |
Reimplemented in resqml2::ContinuousProperty, and resqml2::CommentProperty.
void resqml2::AbstractValuesProperty::pushBackShortHdf5Array1dOfValues | ( | const short * | values, |
uint64_t | valueCount, | ||
eml2::AbstractHdfProxy * | proxy, | ||
short | nullValue | ||
) |
Adds a 1d array of explicit short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCount | The number of values to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackShortHdf5Array2dOfValues | ( | const short * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
short | nullValue | ||
) |
Adds a 2d array of explicit short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackShortHdf5Array3dOfValues | ( | const short * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
short | nullValue | ||
) |
Adds a 3d array of explicit short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
|
virtual |
Adds an nd array of explicit short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
[in] | numValues | The number of property values ordered by dimension of the array to write. |
numDimensionsInArray | The number of dimensions in the array to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
Reimplemented in resqml2::DiscreteProperty.
void resqml2::AbstractValuesProperty::pushBackUShortHdf5Array2dOfValues | ( | const unsigned short * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
unsigned short | nullValue | ||
) |
Adds a 2d array of explicit unsigned short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly J dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
void resqml2::AbstractValuesProperty::pushBackUShortHdf5Array3dOfValues | ( | const unsigned short * | values, |
uint64_t | valueCountInFastestDim, | ||
uint64_t | valueCountInMiddleDim, | ||
uint64_t | valueCountInSlowestDim, | ||
eml2::AbstractHdfProxy * | proxy, | ||
unsigned short | nullValue | ||
) |
Adds a 3d array of explicit unsigned short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
|
virtual |
Adds an nd array of explicit unsigned short values to the property values.
std::logic_error | If the underlying gSOAP instance is not a RESQML2.0 one. |
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined in the repository. |
values | All the property values to set ordered according the topology of the representation it is based on. | |
[in] | numValues | The number of property values ordered by dimension of the array to write. |
numDimensionsInArray | The number of dimensions in the array to write. | |
[in,out] | proxy | The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr , then a default HDF proxy must be defined in the repository. |
nullValue | The null value. |
Reimplemented in resqml2::DiscreteProperty.
void resqml2::AbstractValuesProperty::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)() |
||
) |
Sets some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. Since this methods only pushes back values into an existing array, it is to be used along with pushBackFloatHdf5Array3dOfValues().
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
std::out_of_range | If patchIndex is strictly greater than patch count and different from unsigned int maximum value. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
offsetInFastestDim | The offset value for writing in the fastest dimension (mainly I dimension). | |
offsetInMiddleDim | The offset value for writing in the middle dimension (mainly J dimension). | |
offsetInSlowestDim | The offset value for writing in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository. |
patchIndex | (Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index). |
void resqml2::AbstractValuesProperty::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)() |
||
) |
Set some values of an existing 3d array of explicit float values of a particular patch. This method makes use of HDF5 hyperslabbing. This method is to be used along with one of the pushBackFloatHdf5ArrayOfValues() methods which do not write any value.
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
std::out_of_range | If patchIndex is strictly greater than patch count and different from unsigned int maximum value. |
values | All the property values to set ordered according to the topology of the representation it is based on. | |
numValues | The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. | |
offsetValues | The offset values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. | |
numArrayDimensions | The number of dimensions of the array to write. | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default), a default HDF proxy must be defined into the data object repository. |
patchIndex | (Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index). |
void resqml2::AbstractValuesProperty::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)() |
||
) |
Adds a 3d array of explicit long 64 bits values into the property values. Since this methods only pushes back values into an existing array, it is to be used along with pushBackLongHdf5Array3dOfValues().
std::invalid_argument | If proxy is nullptr and no default HDF proxy is defined into the data object repository. |
std::out_of_range | If patchIndex is strictly greater than patch count and different from unsigned int maximum value. |
[in] | values | All the property values to set ordered according to the topology of the representation it is based on. |
valueCountInFastestDim | The number of values to write in the fastest dimension (mainly I dimension). | |
valueCountInMiddleDim | The number of values to write in the middle dimension (mainly J dimension). | |
valueCountInSlowestDim | The number of values to write in the slowest dimension (mainly K dimension). | |
offsetInFastestDim | The offset value for writing in the fastest dimension (mainly I dimension). | |
offsetInMiddleDim | The offset value for writing in the middle dimension (mainly J dimension). | |
offsetInSlowestDim | The offset value for writing in the slowest dimension (mainly K dimension). | |
[in,out] | proxy | (Optional) The HDF proxy where to write the property values. It must be already opened for writing and won't be closed in this method. If nullptr (default value), a default HDF proxy must be defined into the data object repository. |
patchIndex | (Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index). |
void resqml2::AbstractValuesProperty::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)() |
||
) |
Adds an nd array of explicit long 64 bits values into to the property values. Since this methods only pushes back values into an existing array, it is to be used along with pushBackLongHdf5ArrayOfValues().
std::invalid_argument | If proxy is null and no default HDF proxy is defined into the data object repository. |
std::out_of_range | If patchIndex is strictly greater than patch count and different from unsigned int maximum value. |
[in] | values | All the property values to set ordered according to the topology of the representation it is based on. |
numValues | The number of property values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. | |
offsetValues | The offset values ordered by dimension of the array to write. It is ordered from slowest dimension to fastest dimension. | |
numArrayDimensions | The number of dimensions of the array to write. | |
[in,out] | proxy | (Optional) The 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 (default value), a default HDF proxy must be defined into the data object repository. |
patchIndex | (Optional) Zero-based index of the patch where to write the property values. If not provided, its default value is by convention set to unsigned int maximum value and the property values will be written in the last property values patch (the one with the greatest index). |