Public Member Functions | |
| AbstractIOHandlerImpl (AbstractIOHandler *handler) | |
| virtual std::future< void > | flush () |
| virtual void | closeFile (Writable *, Parameter< Operation::CLOSE_FILE > const &)=0 |
| Close the file corresponding with the writable and release file handles. More... | |
| virtual void | advance (Writable *, Parameter< Operation::ADVANCE > &) |
| Advance the file/stream that this writable belongs to. More... | |
| virtual void | closePath (Writable *, Parameter< Operation::CLOSE_PATH > const &) |
| Close an openPMD group. More... | |
| virtual void | availableChunks (Writable *, Parameter< Operation::AVAILABLE_CHUNKS > &)=0 |
| Report chunks that are available for loading from the dataset represented by this writable. More... | |
| virtual void | createFile (Writable *, Parameter< Operation::CREATE_FILE > const &)=0 |
| Create a new file in physical storage, possibly overriding an existing file. More... | |
| virtual void | createPath (Writable *, Parameter< Operation::CREATE_PATH > const &)=0 |
| Create all necessary groups for a path, possibly recursively. More... | |
| virtual void | createDataset (Writable *, Parameter< Operation::CREATE_DATASET > const &)=0 |
| Create a new dataset of given type, extent and storage properties. More... | |
| virtual void | extendDataset (Writable *, Parameter< Operation::EXTEND_DATASET > const &)=0 |
| Increase the extent of an existing dataset. More... | |
| virtual void | openFile (Writable *, Parameter< Operation::OPEN_FILE > const &)=0 |
| Open an existing file assuming it conforms to openPMD. More... | |
| virtual void | openPath (Writable *, Parameter< Operation::OPEN_PATH > const &)=0 |
| Open all contained groups in a path, possibly recursively. More... | |
| virtual void | openDataset (Writable *, Parameter< Operation::OPEN_DATASET > &)=0 |
| Open an existing dataset and determine its datatype and extent. More... | |
| virtual void | deleteFile (Writable *, Parameter< Operation::DELETE_FILE > const &)=0 |
| Delete an existing file from physical storage. More... | |
| virtual void | deletePath (Writable *, Parameter< Operation::DELETE_PATH > const &)=0 |
| Delete all objects within an existing path. More... | |
| virtual void | deleteDataset (Writable *, Parameter< Operation::DELETE_DATASET > const &)=0 |
| Delete an existing dataset. More... | |
| virtual void | deleteAttribute (Writable *, Parameter< Operation::DELETE_ATT > const &)=0 |
| Delete an existing attribute. More... | |
| virtual void | writeDataset (Writable *, Parameter< Operation::WRITE_DATASET > const &)=0 |
| Write a chunk of data into an existing dataset. More... | |
| virtual void | getBufferView (Writable *, Parameter< Operation::GET_BUFFER_VIEW > ¶meters) |
| Get a view into a dataset buffer that can be filled by a user. More... | |
| virtual void | writeAttribute (Writable *, Parameter< Operation::WRITE_ATT > const &)=0 |
| Create a single attribute and fill the value, possibly overwriting an existing attribute. More... | |
| virtual void | readDataset (Writable *, Parameter< Operation::READ_DATASET > &)=0 |
| Read a chunk of data from an existing dataset. More... | |
| virtual void | readAttribute (Writable *, Parameter< Operation::READ_ATT > &)=0 |
| Read the value of an existing attribute. More... | |
| virtual void | listPaths (Writable *, Parameter< Operation::LIST_PATHS > &)=0 |
| List all paths/sub-groups inside a group, non-recursively. More... | |
| virtual void | listDatasets (Writable *, Parameter< Operation::LIST_DATASETS > &)=0 |
| List all datasets inside a group, non-recursively. More... | |
| virtual void | listAttributes (Writable *, Parameter< Operation::LIST_ATTS > &)=0 |
| List all attributes associated with an object. More... | |
Public Attributes | |
| AbstractIOHandler * | m_handler |
Member Function Documentation
◆ advance()
|
inlinevirtual |
Advance the file/stream that this writable belongs to.
If the backend is based around usage of IO steps (especially streaming backends), open or close an IO step. This is modeled closely after the step concept in ADIOS2.
This task is used to implement streaming-aware semantics in the openPMD API by splitting data into packets that are written to and read from transport.
IO actions up to the point of closing a step must be performed now.
The advance mode is determined by parameters.mode. The return status code shall be stored as parameters.status.
◆ availableChunks()
|
pure virtual |
Report chunks that are available for loading from the dataset represented by this writable.
The resulting chunks should be stored into parameters.chunks.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ closeFile()
|
pure virtual |
Close the file corresponding with the writable and release file handles.
The operation should succeed in any access mode.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ closePath()
|
inlinevirtual |
Close an openPMD group.
This is an optimization-enabling task and may be ignored by backends. Indicates that the group will not be accessed any further. Especially in step-based IO mode (e.g. streaming): Indicates that the group corresponding with the writable needs not be held in a parseable state for this and upcoming IO steps, allowing for deletion of metadata to be sent/stored (attributes, datasets, ..). Should fail if the writable is not written. Should fail if m_handler->accessType is AccessType::READ_ONLY.
◆ createDataset()
|
pure virtual |
Create a new dataset of given type, extent and storage properties.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The path may contain multiple levels (e.g. group/dataset). The new dataset should have the name parameters.name. This name should not start or end with a slash ("/"). The new dataset should be of datatype parameters.dtype. The new dataset should have an extent of parameters.extent. If possible, the new dataset should be extensible. If possible, the new dataset should be divided into chunks with size parameters.chunkSize. If possible, the new dataset should be compressed according to parameters.compression. This may be format-specific. If possible, the new dataset should be transformed accoring to parameters.transform. This may be format-specific. The Writables file position should correspond to the newly created dataset. The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ createFile()
|
pure virtual |
Create a new file in physical storage, possibly overriding an existing file.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The new file should be located in m_handler->directory. The new file should have the filename parameters.name. The filename should include the correct corresponding filename extension. Any existing file should be overwritten if m_handler->m_frontendAccess is Access::CREATE. The Writables file position should correspond to the root group "/" of the hierarchy. The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ createPath()
|
pure virtual |
Create all necessary groups for a path, possibly recursively.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The path parameters.path may contain multiple levels (e.g. first/second/third/). The Writables file position should correspond to the complete newly created path (i.e. first/second/third/ should be assigned to the Writables file position). The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ deleteAttribute()
|
pure virtual |
Delete an existing attribute.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The operation should pass if the Writable was not marked written. The attribute should be associated with the Writable and have the name parameters.name before deletion. The attribute should not be accessible in physical storage after the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ deleteDataset()
|
pure virtual |
Delete an existing dataset.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The operation should pass if the Writable was not marked written. The dataset should have the name parameters.name. This name should not start or end with a slash ("/"). It may also contain the current dataset ".". The dataset should not be accessible in physical storage after the operation completes successfully. The Writables file position should be set to an invalid position (i.e. the pointer should be a nullptr). The Writable should be marked not written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ deleteFile()
|
pure virtual |
Delete an existing file from physical storage.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The operation should pass if the Writable was not marked written. All handles that correspond to the file should be closed before deletion. The file to delete should have the filename parameters.name. The filename should include the correct corresponding filename extension. The Writables file position should be set to an invalid position (i.e. the pointer should be a nullptr). The Writable should be marked not written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ deletePath()
|
pure virtual |
Delete all objects within an existing path.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The operation should pass if the Writable was not marked written. The path parameters.path may contain multiple levels (e.g. first/second/third/). This path should be relative (i.e. it should not start with a slash "/"). It may also contain the current group ".". All groups and datasets starting from the path should not be accessible in physical storage after the operation completes successfully. The Writables file position should be set to an invalid position (i.e. the pointer should be a nullptr). The Writable should be marked not written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ extendDataset()
|
pure virtual |
Increase the extent of an existing dataset.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The operation should fail if the dataset does not yet exist. The dataset should have the name parameters.name. This name should not start or end with a slash ("/"). The operation should fail if the new extent is not strictly large in every dimension. The dataset should have an extent of parameters.extent.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ getBufferView()
|
inlinevirtual |
Get a view into a dataset buffer that can be filled by a user.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The dataset should be associated with the Writable. The operation should fail if the dataset does not exist. The operation should fail if the chunk extent parameters.extent is not smaller or equals in every dimension. The operation should fail if chunk positions parameters.offset+parameters.extent do not reside inside the dataset. The dataset should match the dataype parameters.dtype. The buffer should be stored as a cast-to-char pointer to a flattened version of the backend buffer in parameters.out->ptr. The chunk is stored row-major. The buffer's content should be written to storage not before the next call to AbstractIOHandler::flush where AbstractIOHandler::m_flushLevel == FlushLevel::InternalFlush. The precise time of data consumption is defined by the backend:
- Data written to the returned buffer should be consumed not earlier than the next call to AbstractIOHandler::flush where AbstractIOHandler::m_flushLevel == FlushLevel::InternalFlush.
- Data should be consumed not later than the next Operation::ADVANCE task where parameter.mode == AdvanceMode::ENDSTEP.
This IOTask is optional and should either (1) not be implemented by a backend at all or (2) be implemented as indicated above and set parameters.out->backendManagedBuffer = true.
◆ listAttributes()
|
pure virtual |
List all attributes associated with an object.
The operation should fail if the Writable was not marked written. The attribute should be associated with the Writable. The list of attribute names should be stored in the location indicated by the pointer parameters.attributes.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ listDatasets()
|
pure virtual |
List all datasets inside a group, non-recursively.
The operation should fail if the Writable was not marked written. The operation should fail if the Writable is not a group. The list of dataset names should be stored in the location indicated by the pointer parameters.datasets.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ listPaths()
|
pure virtual |
List all paths/sub-groups inside a group, non-recursively.
The operation should fail if the Writable was not marked written. The operation should fail if the Writable is not a group. The list of group names should be stored in the location indicated by the pointer parameters.paths.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ openDataset()
|
pure virtual |
Open an existing dataset and determine its datatype and extent.
The opened dataset should be located in a group below the group of the Writables parent writable->parent. The opened datasets name should be parameters.name. This name should not start or end with a slash ("/"). The opened datasets datatype should be stored in *(parameters.dtype). The opened datasets extent should be stored in *(parameters.extent). The Writables file position should correspond to the opened dataset. The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ openFile()
|
pure virtual |
Open an existing file assuming it conforms to openPMD.
The operation should fail if m_handler->directory is not accessible. The opened file should have filename parameters.name and include the correct corresponding filename extension. The operation should not open files more than once. If possible, the file should be opened with read-only permissions if m_handler->m_frontendAccess is Access::READ_ONLY. The Writables file position should correspond to the root group "/" of the hierarchy in the opened file. The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ openPath()
|
pure virtual |
Open all contained groups in a path, possibly recursively.
The operation should overwrite existing file positions, even when the Writable was already marked written. The path parameters.path may contain multiple levels (e.g. first/second/third/). This path should be relative (i.e. it should not start with a slash "/"). The number of levels may be zero, i.e. parameters.path may be an empty string. The Writables file position should correspond to the complete opened path (i.e. first/second/third/ should be assigned to the Writables file position). The Writable should be marked written when the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ readAttribute()
|
pure virtual |
Read the value of an existing attribute.
The operation should fail if the Writable was not marked written. The operation should fail if the attribute does not exist. The attribute should be associated with the Writable and have the name parameters.name. This name should not contain a slash ("/"). The attribute datatype should be stored in the location indicated by the pointer parameters.dtype. The attribute value should be stored as a generic Variant::resource in the location indicated by the pointer parameters.resource. All datatypes of Datatype should be supported in a type-safe way.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ readDataset()
|
pure virtual |
Read a chunk of data from an existing dataset.
The dataset should be associated with the Writable. The operation should fail if the dataset does not exist. The operation should fail if the chunk extent parameters.extent is not smaller or equals in every dimension. The operation should fail if chunk positions parameters.offset+parameters.extent do not reside inside the dataset. The dataset should match the dataype parameters.dtype. The data parameters.data should be a cast-to-void pointer to a flattened version of the chunk data. The chunk should be stored row-major. The region of the chunk should be written to the location indicated by the pointer after the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ writeAttribute()
|
pure virtual |
Create a single attribute and fill the value, possibly overwriting an existing attribute.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The attribute should have the name parameters.name. This name should not contain a slash ("/"). The attribute should be of datatype parameters.dtype. Any existing attribute with the same name should be overwritten. If possible, only the value should be changed if the datatype stays the same. The attribute should be written to physical storage after the operation completes successfully. All datatypes of Datatype should be supported in a type-safe way.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
◆ writeDataset()
|
pure virtual |
Write a chunk of data into an existing dataset.
The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY. The dataset should be associated with the Writable. The operation should fail if the dataset does not exist. The operation should fail if the chunk extent parameters.extent is not smaller or equals in every dimension. The operation should fail if chunk positions parameters.offset+parameters.extent do not reside inside the dataset. The dataset should match the dataype parameters.dtype. The data parameters.data is a cast-to-void pointer to a flattened version of the chunk data. It should be re-cast to the provided datatype. The chunk is stored row-major. The region of the chunk should be written to physical storage after the operation completes successfully.
Implemented in openPMD::JSONIOHandlerImpl, openPMD::ADIOS1IOHandlerImpl, and openPMD::HDF5IOHandlerImpl.
The documentation for this class was generated from the following file:
- /tmp/tmp.7iNmvGSbic/openPMD-api/include/openPMD/IO/AbstractIOHandlerImpl.hpp
