common::HdfProxyFactory Class Reference

An HDF5 file proxy factory. More...

#include <HdfProxyFactory.h>

Inheritance diagram for common::HdfProxyFactory:

Public Member Functions
virtual	~HdfProxyFactory ()=default
virtual eml2::AbstractHdfProxy *	make (const DataObjectReference &dor)
	Creates an instance of HDF5 file proxy. Only to be used in partial transfer context. More...
virtual eml2::AbstractHdfProxy *	make (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap)
virtual eml2::AbstractHdfProxy *	make (gsoap_eml2_3::_eml23__EpcExternalPartReference *fromGsoap)
virtual eml2::AbstractHdfProxy *	make (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 HDF5 file proxy for serialization purpose. More...

Detailed Description

An HDF5 file proxy factory.

Constructor & Destructor Documentation

~HdfProxyFactory()

virtual common::HdfProxyFactory::~HdfProxyFactory ( )

virtualdefault

Destructor

Member Function Documentation

make() [1/4]

virtual eml2::AbstractHdfProxy* common::HdfProxyFactory::make ( 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  )

virtual

Creates an instance of HDF5 file proxy for serialization purpose.

Exceptions

std::invalid_argument	If repo == nullptr.
std::invalid_argument	If the Energistics standard is unrecognized.

Parameters

[in]	repo	A non-null data object repository.
	guid	The guid to set to the HDF5 file proxy. If empty then a new guid will be generated.
	title	The title to set to the HDF5 file proxy. If empty then "unknown" title will be set.
	packageDirAbsolutePath	Path of the directory containing the EPC file.
	externalFilePath	Path of the HDF5 file relative to the directory where the EPC document is stored.
	hdfPermissionAccess	(Optional) The HDF5 file permission access. It is read only by default.

Returns

A pointer to an instantiated HDF5 file proxy.

Reimplemented in ETP_NS::EtpHdfProxyFactory.

make() [2/4]

virtual eml2::AbstractHdfProxy* common::HdfProxyFactory::make ( const DataObjectReference &  dor )

virtual

Creates an instance of HDF5 file proxy. Only to be used in partial transfer context.

Exceptions

std::logic_error

Raised when a logic error condition occurs.

Parameters

[in]

dor

If non-null, the dor.

Returns

A pointer to an instantiated HDF5 file proxy.

Reimplemented in ETP_NS::EtpHdfProxyFactory.

make() [3/4]

virtual eml2::AbstractHdfProxy* common::HdfProxyFactory::make ( gsoap_eml2_3::_eml23__EpcExternalPartReference *  fromGsoap )

virtual

Creates an instance of HDF5 file proxy by wrapping a gSOAP instance.

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

Returns

A pointer to an instantiated HDF5 file proxy.

make() [4/4]

virtual eml2::AbstractHdfProxy* common::HdfProxyFactory::make ( gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *  fromGsoap )

inlinevirtual

Creates an instance of HDF5 file proxy by wrapping a gSOAP instance.

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

Returns

A pointer to an instantiated HDF5 file proxy.

Reimplemented in ETP_NS::EtpHdfProxyFactory, and common::HdfProxyROS3Factory.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/common/HdfProxyFactory.h