Fesapi 2.3.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
eml2_3::HdfProxy Class Referencefinal

#include <HdfProxy.h>

Inheritance diagram for eml2_3::HdfProxy:
eml2::HdfProxy eml2::AbstractHdfProxy eml2::EpcExternalPartReference common::AbstractObject

Public Member Functions

 HdfProxy (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 HdfProxy (const common::DataObjectReference &dor)
 Constructor. More...
 
 HdfProxy (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, const std::string &packageDirAbsolutePath, const std::string &externalFilePath, common::DataObjectRepository::openingMode hdfPermissionAccess=common::DataObjectRepository::openingMode::READ_ONLY)
 
 HdfProxy (gsoap_eml2_3::_eml23__EpcExternalPartReference *fromGsoap)
 
 ~HdfProxy ()=default
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from eml2::HdfProxy
 HdfProxy (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 HdfProxy (const common::DataObjectReference &dor)
 Constructor. More...
 
virtual ~HdfProxy ()
 
void open () override
 
bool isOpened () const final
 
void close () final
 
common::AbstractObject::hdfDatatypeEnum getHdfDatatypeInDataset (const std::string &groupName) final
 
int getHdfDatatypeClassInDataset (const std::string &datasetName) final
 
void writeItemizedListOfList (const std::string &groupName, const std::string &name, hdf5_hid_t cumulativeLengthDatatype, const void *cumulativeLength, unsigned long long cumulativeLengthSize, hdf5_hid_t elementsDatatype, const void *elements, unsigned long long elementsSize) final
 
unsigned int getDimensionCount (const std::string &datasetName) final
 
std::vector< unsigned long long > getElementCountPerDimension (const std::string &datasetName) final
 
signed long long getElementCount (const std::string &datasetName) final
 
void setCompressionLevel (unsigned int newCompressionLevel) final
 
void writeArrayNdOfFloatValues (const std::string &groupName, const std::string &name, const float *floatValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdOfDoubleValues (const std::string &groupName, const std::string &name, const double *dblValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdOfCharValues (const std::string &groupName, const std::string &name, const char *intValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdOfIntValues (const std::string &groupName, const std::string &name, const int *intValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdOfInt64Values (const std::string &groupName, const std::string &name, const int64_t *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdOfUInt64Values (const std::string &groupName, const std::string &name, const uint64_t *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNd (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const void *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void createArrayNd (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions) final
 
void writeArrayNdSlab (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const void *values, const unsigned long long *numValuesInEachDimension, const unsigned long long *offsetValuesInEachDimension, unsigned int numDimensions) final
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values) final
 
void writeGroupAttribute (const std::string &groupName, const std::string &attributeName, const std::vector< std::string > &values) final
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< double > &values) final
 
void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< int > &values) final
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values) final
 
void writeDatasetAttribute (const std::string &datasetName, const std::string &attributeName, const std::vector< std::string > &values) final
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< double > &values) final
 
void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< int > &values) final
 
std::string readStringAttribute (const std::string &obj_name, const std::string &attr_name) const final
 
std::vector< std::string > readStringArrayAttribute (const std::string &obj_name, const std::string &attr_name) const final
 
double readDoubleAttribute (const std::string &obj_name, const std::string &attr_name) const final
 
int64_t readLongAttribute (const std::string &obj_name, const std::string &attr_name) const final
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values) final
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numDimensions) final
 
void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long const *blockCountPerDimension, unsigned long long const *offsetInEachDimension, unsigned long long const *strideInEachDimension, unsigned long long const *blockSizeInEachDimension, unsigned int numDimensions) final
 
void selectArrayNdOfValues (const std::string &datasetName, unsigned long long const *blockCountPerDimension, unsigned long long const *offsetInEachDimension, unsigned long long const *strideInEachDimension, unsigned long long 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, unsigned long long slabSize) final
 
void readArrayNdOfFloatValues (const std::string &datasetName, float *values) final
 
void readArrayNdOfFloatValues (const std::string &datasetName, float *values, unsigned long long const *numValuesInEachDimension, unsigned long long 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, unsigned long long const *numValuesInEachDimension, unsigned long long 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, unsigned long long const *numValuesInEachDimension, unsigned long long 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 readArrayNdOfCharValues (const std::string &datasetName, char *values) final
 
void readArrayNdOfUCharValues (const std::string &datasetName, unsigned char *values) final
 
std::vector< unsigned long long > readArrayDimensions (const std::string &datasetName) final
 
bool exist (const std::string &absolutePathInHdfFile) const final
 
bool isCompressed (const std::string &datasetName) final
 
std::vector< unsigned long long > getElementCountPerChunkDimension (const std::string &datasetName) final
 
- Public Member Functions inherited from eml2::AbstractHdfProxy
virtual ~AbstractHdfProxy ()=default
 
void setRootPath (const std::string &rootPath)
 
void setRelativePath (const std::string &relPath)
 
void setOpeningMode (common::DataObjectRepository::openingMode openingMode_)
 
const std::string & getRelativePath () const
 
virtual void open ()=0
 
virtual bool isOpened () const =0
 
virtual void close ()=0
 
virtual common::AbstractObject::hdfDatatypeEnum getHdfDatatypeInDataset (const std::string &datasetName)=0
 
virtual int getHdfDatatypeClassInDataset (const std::string &datasetName)=0
 
virtual void writeItemizedListOfList (const std::string &groupName, const std::string &name, hdf5_hid_t cumulativeLengthDatatype, const void *cumulativeLength, unsigned long long cumulativeLengthSize, hdf5_hid_t elementsDatatype, const void *elements, unsigned long long elementsSize)=0
 
virtual unsigned int getDimensionCount (const std::string &datasetName)=0
 
virtual std::vector< unsigned long long > getElementCountPerDimension (const std::string &datasetName)=0
 
virtual signed long long getElementCount (const std::string &datasetName)=0
 
virtual void setCompressionLevel (unsigned int newCompressionLevel)=0
 
virtual void writeArrayNdOfFloatValues (const std::string &groupName, const std::string &name, const float *floatValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdOfDoubleValues (const std::string &groupName, const std::string &name, const double *dblValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdOfCharValues (const std::string &groupName, const std::string &name, const char *intValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdOfIntValues (const std::string &groupName, const std::string &name, const int *intValues, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdOfInt64Values (const std::string &groupName, const std::string &name, const int64_t *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdOfUInt64Values (const std::string &groupName, const std::string &name, const uint64_t *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNd (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const void *values, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void createArrayNd (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const unsigned long long *numValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeArrayNdSlab (const std::string &groupName, const std::string &name, hdf5_hid_t datatype, const void *values, const unsigned long long *numValuesInEachDimension, const unsigned long long *offsetValuesInEachDimension, unsigned int numDimensions)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)=0
 
virtual void writeGroupAttribute (const std::string &groupName, const std::string &attributeName, const std::vector< std::string > &values)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)=0
 
virtual void writeGroupAttributes (const std::string &groupName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< std::string > &values)=0
 
virtual void writeDatasetAttribute (const std::string &datasetName, const std::string &attributeName, const std::vector< std::string > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< double > &values)=0
 
virtual void writeDatasetAttributes (const std::string &datasetName, const std::vector< std::string > &attributeNames, const std::vector< int > &values)=0
 
virtual std::string readStringAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual std::vector< std::string > readStringArrayAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual double readDoubleAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual int64_t readLongAttribute (const std::string &obj_name, const std::string &attr_name) const =0
 
virtual void readArrayNdOfDoubleValues (const std::string &datasetName, double *values)=0
 
virtual void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numDimensions)=0
 
virtual void readArrayNdOfDoubleValues (const std::string &datasetName, double *values, unsigned long long const *blockCountPerDimension, unsigned long long const *offsetInEachDimension, unsigned long long const *strideInEachDimension, unsigned long long const *blockSizeInEachDimension, unsigned int numDimensions)=0
 
virtual void selectArrayNdOfValues (const std::string &datasetName, unsigned long long const *blockCountPerDimension, unsigned long long const *offsetInEachDimension, unsigned long long const *strideInEachDimension, unsigned long long const *blockSizeInEachDimension, unsigned int numDimensions, bool newSelection, hdf5_hid_t &dataset, hdf5_hid_t &filespace)=0
 
virtual void readArrayNdOfDoubleValues (hdf5_hid_t dataset, hdf5_hid_t filespace, void *values, unsigned long long slabSize)=0
 
virtual void readArrayNdOfFloatValues (const std::string &datasetName, float *values)=0
 
virtual void readArrayNdOfFloatValues (const std::string &datasetName, float *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numDimensions)=0
 
virtual void readArrayNdOfInt64Values (const std::string &datasetName, int64_t *values)=0
 
virtual void readArrayNdOfInt64Values (const std::string &datasetName, int64_t *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numDimensions)=0
 
virtual void readArrayNdOfUInt64Values (const std::string &datasetName, uint64_t *values)=0
 
virtual void readArrayNdOfIntValues (const std::string &datasetName, int *values)=0
 
virtual void readArrayNdOfIntValues (const std::string &datasetName, int *values, unsigned long long const *numValuesInEachDimension, unsigned long long const *offsetInEachDimension, unsigned int numDimensions)=0
 
virtual void readArrayNdOfUIntValues (const std::string &datasetName, unsigned int *values)=0
 
virtual void readArrayNdOfShortValues (const std::string &datasetName, short *values)=0
 
virtual void readArrayNdOfUShortValues (const std::string &datasetName, unsigned short *values)=0
 
virtual void readArrayNdOfCharValues (const std::string &datasetName, char *values)=0
 
virtual void readArrayNdOfUCharValues (const std::string &datasetName, unsigned char *values)=0
 
virtual std::vector< unsigned long long > readArrayDimensions (const std::string &datasetName)=0
 
virtual bool exist (const std::string &absolutePathInHdfFile) const =0
 
virtual bool isCompressed (const std::string &datasetName)=0
 
void setMaxChunkSize (unsigned int newMaxChunkSize)
 
virtual std::vector< unsigned long long > getElementCountPerChunkDimension (const std::string &datasetName)=0
 
void initGsoapProxy (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, unsigned int emlVersion)
 
- Public Member Functions inherited from eml2::EpcExternalPartReference
virtual ~EpcExternalPartReference ()=default
 
virtual std::string getXmlTag () const final
 
- 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_1::eml21__AbstractObject * getEml21GsoapProxy () const
 
void setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)
 
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
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 
virtual void loadTargetRelationships ()=0
 

Static Public Attributes

static const char * XML_NS
 
- Static Public Attributes inherited from eml2::EpcExternalPartReference
static const char * XML_TAG
 

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)
 

Detailed Description

A hdf proxy.

Constructor & Destructor Documentation

◆ HdfProxy() [1/4]

eml2_3::HdfProxy::HdfProxy ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ HdfProxy() [2/4]

eml2_3::HdfProxy::HdfProxy ( const common::DataObjectReference &  dor)
inline

Constructor.

Parameters
dorThe dor.

◆ HdfProxy() [3/4]

eml2_3::HdfProxy::HdfProxy ( common::DataObjectRepository *  repo,
const std::string &  guid,
const std::string &  title,
const std::string &  packageDirAbsolutePath,
const std::string &  externalFilePath,
common::DataObjectRepository::openingMode  hdfPermissionAccess = common::DataObjectRepository::openingMode::READ_ONLY 
)

Creates an instance of this class in a gsoap context.

Parameters
[in,out]repoThe repo where the underlying gsoap proxy is going to be created.
guidThe guid of the underlying gsoap proxy to be created.
titleThe title of the underlying gsoap proxy to be created.
packageDirAbsolutePathThe directory where the EPC document is stored. Must end with a slash or back- slash.
externalFilePathThe relative file path of the associated HDF file. It is relative to the location of the package.
hdfPermissionAccess(Optional) The hdf permission access.

◆ HdfProxy() [4/4]

eml2_3::HdfProxy::HdfProxy ( gsoap_eml2_3::_eml23__EpcExternalPartReference *  fromGsoap)
inline

Hdf proxy

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~HdfProxy()

eml2_3::HdfProxy::~HdfProxy ( )
virtualdefault

Destructor

Reimplemented from eml2::HdfProxy.

Member Function Documentation

◆ getXmlNamespace()

std::string eml2_3::HdfProxy::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

const char* eml2_3::HdfProxy::XML_NS
static

The standard XML namespace for serializing this data object.

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