FETPAPI 0.3.0.0
This project provides C++ classes which facilitate the developement of ETP1.2 clients and servers.
|
Public Member Functions | |
FesapiHdfProxy (AbstractSession *session, COMMON_NS::DataObjectRepository *repo, const std::string &guid, const std::string &title, const std::string &packageDirAbsolutePath, const std::string &externalFilePath, COMMON_NS::DataObjectRepository::openingMode hdfPermissionAccess) | |
FesapiHdfProxy (AbstractSession *session, gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap) | |
FesapiHdfProxy (AbstractSession *session, const COMMON_NS::DataObjectReference &dor) | |
~FesapiHdfProxy ()=default | |
AbstractSession * | getSession () |
void | open () final |
bool | isOpened () const final |
void | close () final |
COMMON_NS::AbstractObject::numericalDatatypeEnum | getNumericalDatatype (const std::string &groupName) final |
int | getHdfDatatypeClassInDataset (const std::string &datasetName) final |
void | writeItemizedListOfList (const std::string &groupName, const std::string &name, COMMON_NS::AbstractObject::numericalDatatypeEnum cumulativeLengthDatatype, const void *cumulativeLength, uint64_t cumulativeLengthSize, COMMON_NS::AbstractObject::numericalDatatypeEnum elementsDatatype, const void *elements, uint64_t elementsSize) final |
std::vector< uint32_t > | getElementCountPerDimension (const std::string &datasetName) final |
void | setCompressionLevel (unsigned int newCompressionLevel) final |
void | writeArrayNd (const std::string &groupName, const std::string &name, COMMON_NS::AbstractObject::numericalDatatypeEnum datatype, const void *values, const uint64_t *numValuesInEachDimension, unsigned int numDimensions) final |
void | createArrayNd (const std::string &groupName, const std::string &name, COMMON_NS::AbstractObject::numericalDatatypeEnum datatype, const uint64_t *numValuesInEachDimension, unsigned int numDimensions) final |
void | writeArrayNdSlab (const std::string &groupName, const std::string &name, COMMON_NS::AbstractObject::numericalDatatypeEnum datatype, const void *values, const uint64_t *numValuesInEachDimension, const uint64_t *offsetValuesInEachDimension, unsigned int numDimensions) final |
void | writeGroupAttributes (const std::string &, const std::vector< std::string > &, const std::vector< std::string > &) final |
void | writeGroupAttribute (const std::string &, const std::string &, const std::vector< std::string > &) final |
void | writeGroupAttributes (const std::string &, const std::vector< std::string > &, const std::vector< double > &) |
void | writeGroupAttributes (const std::string &, const std::vector< std::string > &, const std::vector< int > &) final |
void | writeDatasetAttributes (const std::string &, const std::vector< std::string > &, const std::vector< std::string > &) final |
void | writeDatasetAttribute (const std::string &, const std::string &, const std::vector< std::string > &) final |
void | writeDatasetAttributes (const std::string &, const std::vector< std::string > &, const std::vector< double > &) final |
void | writeDatasetAttributes (const std::string &, const std::vector< std::string > &, const std::vector< int > &) final |
std::string | readStringAttribute (const std::string &, const std::string &) const final |
std::vector< std::string > | readStringArrayAttribute (const std::string &, const std::string &) const final |
double | readDoubleAttribute (const std::string &, const std::string &) const final |
int64_t | readInt64Attribute (const std::string &, const std::string &) const final |
void | readArrayNdOfDoubleValues (const std::string &datasetName, double *values) final |
void | readArrayNdOfDoubleValues (const std::string &datasetName, double *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numDimensions) final |
void | readArrayNdOfDoubleValues (const std::string &datasetName, double *values, uint64_t const *blockCountPerDimension, uint64_t const *offsetInEachDimension, uint64_t const *strideInEachDimension, uint64_t const *blockSizeInEachDimension, unsigned int numDimensions) final |
void | selectArrayNdOfValues (const std::string &datasetName, uint64_t const *blockCountPerDimension, uint64_t const *offsetInEachDimension, uint64_t const *strideInEachDimension, uint64_t const *blockSizeInEachDimension, unsigned int numDimensions, bool newSelection, hdf5_hid_t &dataset, hdf5_hid_t &filespace) final |
void | readArrayNdOfDoubleValues (hdf5_hid_t dataset, hdf5_hid_t filespace, void *values, uint64_t slabSize) final |
void | readArrayNdOfFloatValues (const std::string &datasetName, float *values) final |
void | readArrayNdOfFloatValues (const std::string &datasetName, float *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numDimensions) final |
void | readArrayNdOfInt64Values (const std::string &datasetName, int64_t *values) final |
void | readArrayNdOfInt64Values (const std::string &datasetName, int64_t *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numDimensions) final |
void | readArrayNdOfUInt64Values (const std::string &datasetName, uint64_t *values) final |
void | readArrayNdOfIntValues (const std::string &datasetName, int *values) final |
void | readArrayNdOfIntValues (const std::string &datasetName, int *values, uint64_t const *numValuesInEachDimension, uint64_t const *offsetInEachDimension, unsigned int numDimensions) final |
void | readArrayNdOfUIntValues (const std::string &datasetName, unsigned int *values) final |
void | readArrayNdOfShortValues (const std::string &datasetName, short *values) final |
void | readArrayNdOfUShortValues (const std::string &datasetName, unsigned short *values) final |
void | readArrayNdOfInt8Values (const std::string &datasetName, int8_t *values) final |
void | readArrayNdOfUInt8Values (const std::string &datasetName, uint8_t *values) final |
bool | exist (const std::string &absolutePathInHdfFile) const final |
bool | isCompressed (const std::string &) final |
std::vector< uint32_t > | getElementCountPerChunkDimension (const std::string &) final |
std::string | getXmlNamespace () const |
|
inline |
Serialization context
|
inline |
Deserialization context
|
inline |
Only for partial transfer
|
default |
Destructor.
|
inlinefinal |
Does nothing since the ETP session can be used for other purpose.
|
final |
Create an array (potentially with multi dimensions) of a specific datatype into the HDF file. Values are not yet written to this array.
groupName | The name of the group where to create the array of double values. This name must not contain '/' character and must be directly contained in RESQML group. |
name | The name of the array (potentially with multi dimensions) of a specific datatype hdf dataset. It must not exist. |
datatype | The specific datatype of the values to write. |
numValuesInEachDimension | Number of values in each dimension of the array to write. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to write. |
|
final |
Check wether an absolute path exists in the hdf file or not.
|
inlinefinal |
Get the number of elements in each chunk dimension of an HDF5 dataset. If the dataset is not compressed, then it returns an empty vector.
datasetName | The absolute name of the dataset which we want to get the number of elements from. |
|
final |
Get the number of elements in each dimension in an HDF dataset of the proxy.
datasetName | The absolute name of the dataset we want to get the number of elements. |
|
final |
Get the used datatype class in a dataset To compare with H5T_INTEGER, H5T_FLOAT , H5T_STRING , etc...
|
inline |
Get the standard XML namespace for serializing this data object.
|
inlinefinal |
Check wether a dataset is compressed or not. From an ETP client point of view, the dataset is not compressed even if it may be on server storage or even on the websocket.
|
inlinefinal |
It is opened if the ETP session is opened
|
inlinefinal |
Does nothing since the ETP session must already be opened.
|
inlinefinal |
Read an array Nd of double values stored in a specific dataset
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
final |
Find the array associated with datasetName
and read from it.
datasetName | The name of the array (potentially with multi dimensions). |
values | 1d array output of double values ordered firstly by fastest direction. |
blockCountPerDimension | Number of blocks to select from the dataspace, in each dimension. They are ordered from fastest index to slowest index. |
offsetInEachDimension | Offset values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
strideInEachDimension | Number of elements to move from one block to another in each dimension. They are ordered from fastest index to slowest index. |
blockSizeInEachDimension | Size of selected blocks in each dimension. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to read. |
|
final |
Find the array associated with datasetName
and read from it.
datasetName | The name of the array (potentially with multi dimensions). |
values | 1d array output of double values ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
offsetValuesInEachDimension | Offset values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to read. |
|
final |
Considering a given dataset, read the double values corresponding to an existing selected region.
dataset | ID of the dataset to read from. |
filespace | ID of the selected region. |
values | 1d array output of double values ordered firstly by fastest direction. |
slabSize | Number of values to read. |
|
inlinefinal |
Read an array Nd of float values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
final |
Find the array associated with datasetName
and read from it.
datasetName | The name of the array (potentially with multi dimensions). |
values | 1d array output of float values ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
offsetValuesInEachDimension | Offset values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to read. |
|
inlinefinal |
Read an array Nd of int 64 bits values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
final |
Find the array associated with datasetName and read from it.
datasetName | The name of the array (potentially with multi dimensions). |
values | 1d array output of int 64 bits values ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
offsetValuesInEachDimension | Offset values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to read. |
|
inlinefinal |
Read an array Nd of int 8 bits values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
inlinefinal |
Read an array Nd of int values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
final |
Find the array associated with datasetName and read from it.
datasetName | The name of the array (potentially with multi dimensions). |
values | 1d array output of int values ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
offsetValuesInEachDimension | Offset values in each dimension of the array to read. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to read. |
|
inlinefinal |
Read an array Nd of short values stored in a specific dataset Don"t forget to delete the allocated pointer when no more necessary.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
inlinefinal |
Read an array Nd of unsigned int 64 bits values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
inlinefinal |
Read an array Nd of int 8 bits values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
|
inlinefinal |
Read an array Nd of unsigned int values stored in a specific dataset Don"t forget to delete the allocated pointer when no more necessary.
datasetName | The absolute dataset name where to read the values |
|
inlinefinal |
Read an array Nd of unsigned short values stored in a specific dataset.
datasetName | The absolute dataset name where to read the values |
values | The values must be pre-allocated. |
|
inlinefinal |
Set the new compression level which will be used for all data to be written
compressionLevel | Lower compression levels are faster but result in less compression. Range [0..9] is allowed. |
|
final |
Write an array (potentially with multi dimensions) of a specific datatype into the HDF file by means of a single dataset.
groupName | The name of the group where to create the array of values. This name must not contain '/' character and must be directly contained in RESQML group. |
name | The name of the array (potentially with multi dimensions) of a specific datatype hdf dataset. It must not already exist. |
datatype | The specific datatype of the values to write. |
values | 1d array of specific datatype ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to write. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to write |
|
final |
Find the array associated with groupName
and name
and write to it.
groupName | The name of the group associated with the array. |
name | The name of the array (potentially with multi dimensions). |
datatype | The specific datatype of the values to write. |
values | 1d array of specific datatype ordered firstly by fastest direction. |
numValuesInEachDimension | Number of values in each dimension of the array to write. They are ordered from fastest index to slowest index. |
offsetValuesInEachDimension | Offset values in each dimension of the array to write. They are ordered from fastest index to slowest index. |
numDimensions | The number of the dimensions of the array to write. |
|
inlinefinal |
Write a single attribute which contain an array of strings
|
inlinefinal |
Write some double attributes into a dataset
|
inlinefinal |
Write some int attributes into a dataset
|
inlinefinal |
Write some string attributes into a dataset
|
inlinefinal |
Write a single attribute which contain an array of strings
|
inline |
Write some double attributes into a group
|
inlinefinal |
Write some int attributes into a group
|
inlinefinal |
Write some string attributes into a group
|
final |
Write an itemized list of list into the HDF file by means of a single group containing 2 datasets.
groupName | The name of the group where to create the itemized list of list. This name must not contain '/' character and must be directly contained in RESQML group. |
name | The name of the itemized list of list hdf group. |
cumulativeLengthDatatype | The datatype of the cumulative length to write. |
cumulativeLength | 1d array of positive integers containing for each list the sum of all the previous list lengths including the current one |
cumulativeLengthSize | Size of the cumulativeLength array. |
elementsDatatype | The datatype of the elements to write. |
elements | 1d array of elements containing the aggregation of individual list content. |
elementsSize | Size of the elements array. |