openPMD-api
Public Member Functions | List of all members
openPMD::HDF5IOHandler Class Reference
Inheritance diagram for openPMD::HDF5IOHandler:
Inheritance graph
[legend]
Collaboration diagram for openPMD::HDF5IOHandler:
Collaboration graph
[legend]

Public Member Functions

 HDF5IOHandler (std::string path, Access, json::TracingJSON config)
 
std::string backendName () const override
 The currently used backend.
 
std::future< void > flush (internal::ParsedFlushParams &) override
 Process operations in queue according to FIFO. More...
 
- Public Member Functions inherited from openPMD::AbstractIOHandler
 AbstractIOHandler (std::string path, Access at, MPI_Comm)
 
 AbstractIOHandler (std::string path, Access at)
 
 AbstractIOHandler (AbstractIOHandler const &)=default
 
 AbstractIOHandler (AbstractIOHandler &&)=default
 
AbstractIOHandleroperator= (AbstractIOHandler const &)=default
 
AbstractIOHandleroperator= (AbstractIOHandler &&)=default
 
virtual void enqueue (IOTask const &iotask)
 Add provided task to queue according to FIFO. More...
 
std::future< void > flush (internal::FlushParams const &)
 Process operations in queue according to FIFO. More...
 

Additional Inherited Members

- Public Attributes inherited from openPMD::AbstractIOHandler
std::string directory
 
Access m_backendAccess
 
Access m_frontendAccess
 
internal::SeriesStatus m_seriesStatus = internal::SeriesStatus::Default
 
std::queue< IOTaskm_work
 
bool m_lastFlushSuccessful = false
 This is to avoid that the destructor tries flushing again if an error happened. More...
 

Member Function Documentation

◆ flush()

std::future< void > openPMD::HDF5IOHandler::flush ( internal::ParsedFlushParams )
overridevirtual

Process operations in queue according to FIFO.

Returns
Future indicating the completion state of the operation for backends that decide to implement this operation asynchronously.

Implements openPMD::AbstractIOHandler.


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