#include <HdfProxyROS3.h>

Inheritance diagram for eml2_0::HdfProxyROS3:

Public Member Functions
	HdfProxyROS3 (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject, const std::string &secretId="", const std::string &secretKey_="")
	Only to be used in partial transfer context. More...

	HdfProxyROS3 (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap, const std::string &secretId="", const std::string &secretKey_="")
	Constructor. More...

	~HdfProxyROS3 ()=default

void	open ()

Public Member Functions inherited from eml2_0::HdfProxy
	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_resqml2_0_1::_eml20__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...

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

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

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)

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	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)

Static Public Attributes inherited from eml2_0::HdfProxy
static const char *	XML_NS

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

Detailed Description

This class allows to open an HDF5 file for reading only which is located on an AWS S3 bucket.

Constructor & Destructor Documentation

◆ HdfProxyROS3() [1/2]

eml2_0::HdfProxyROS3::HdfProxyROS3	(	gsoap_resqml2_0_1::eml20__DataObjectReference *	partialObject,
		const std::string &	secretId = `""`,
		const std::string &	secretKey_ = `""`
	)

inline

Only to be used in partial transfer context.

Parameters

[in]	partialObject	If non-nullptr, the partial object.
	secretId	(Optional) Identifier for the secret.
	secretKey_	(Optional) The secret key.

◆ HdfProxyROS3() [2/2]

eml2_0::HdfProxyROS3::HdfProxyROS3	(	gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *	fromGsoap,
		const std::string &	secretId = `""`,
		const std::string &	secretKey_ = `""`
	)

inline

Constructor.

Parameters

[in]	fromGsoap	If non-nullptr, from gsoap.
	secretId	(Optional) Identifier for the secret.
	secretKey_	(Optional) The secret key.

◆ ~HdfProxyROS3()

eml2_0::HdfProxyROS3::~HdfProxyROS3 ( )

default

Destructor

Member Function Documentation

◆ open()

void eml2_0::HdfProxyROS3::open ( )

virtual

Open the file for reading.

Reimplemented from eml2::HdfProxy.

The documentation for this class was generated from the following file:

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/eml2_0/HdfProxyROS3.h

Public Member Functions