Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
eml2_0::HdfProxyMPI Class Referencefinal

#include <HdfProxyMPI.h>

Inheritance diagram for eml2_0::HdfProxyMPI:

Public Member Functions

 HdfProxyMPI (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 HdfProxyMPI (const common ::DataObjectReference &dor)
 Constructor.
 
 HdfProxyMPI (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)
 
 HdfProxyMPI (gsoap_resqml2_0_1::_eml20__EpcExternalPartReference *fromGsoap)
 
 ~HdfProxyMPI ()=default
 
void open () final
 
void setMPICommunicator (MPI_Comm communicator)
 
void setCollectiveIO ()
 Set IO to collective.
 
void setIndependentIO ()
 Set IO to independent (default)
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static constexpr char const * XML_NS = "eml20"
 

Detailed Description

This class allows to open an HDF5 file using Parallel HDF5 (MPI) for writing with multiple processes

Constructor & Destructor Documentation

◆ HdfProxyMPI() [1/4]

eml2_0::HdfProxyMPI::HdfProxyMPI ( 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.

◆ HdfProxyMPI() [2/4]

eml2_0::HdfProxyMPI::HdfProxyMPI ( const common ::DataObjectReference & dor)
inline

Constructor.

Parameters
dorThe dor.

◆ HdfProxyMPI() [3/4]

eml2_0::HdfProxyMPI::HdfProxyMPI ( 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 )
inline

Creates an instance of this class in a gsoap context for writing.

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.

◆ HdfProxyMPI() [4/4]

eml2_0::HdfProxyMPI::HdfProxyMPI ( gsoap_resqml2_0_1::_eml20__EpcExternalPartReference * fromGsoap)
inline

Hdf proxy

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

◆ ~HdfProxyMPI()

eml2_0::HdfProxyMPI::~HdfProxyMPI ( )
default

Destructor

Member Function Documentation

◆ getXmlNamespace()

std::string eml2_0::HdfProxyMPI::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ open()

void eml2_0::HdfProxyMPI::open ( )
final

Open the file for reading.

◆ setCollectiveIO()

void eml2_0::HdfProxyMPI::setCollectiveIO ( )

Set IO to collective.

necessary to write with compression enabled

◆ setMPICommunicator()

void eml2_0::HdfProxyMPI::setMPICommunicator ( MPI_Comm communicator)
inline

Set the MPI communicator to use

Member Data Documentation

◆ XML_NS

constexpr char const* eml2_0::HdfProxyMPI::XML_NS = "eml20"
staticconstexpr

The standard XML namespace for serializing this data object.


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