23 #include "openPMD/Error.hpp"
24 #include "openPMD/IO/AbstractIOHandler.hpp"
25 #include "openPMD/IO/IOTask.hpp"
26 #include "openPMD/auxiliary/DerefDynamicCast.hpp"
42 std::future<void> flush();
79 if (parameters.isThisStepMandatory)
83 "Variable-based encoding requires backend support for IO steps "
84 "in order to store more than one iteration (only supported in "
311 parameters.out->backendManagedBuffer =
false;
399 bool m_verboseIOTasks =
false;
402 template <
typename... Args>
403 void writeToStderr(Args &&...)
const;
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:186
virtual std::string backendName() const =0
The currently used backend.
Definition: AbstractIOHandlerImpl.hpp:36
virtual void deleteDataset(Writable *, Parameter< Operation::DELETE_DATASET > const &)=0
Delete an existing dataset.
virtual void writeDataset(Writable *, Parameter< Operation::WRITE_DATASET > &)=0
Write a chunk of data into an existing dataset.
virtual void readDataset(Writable *, Parameter< Operation::READ_DATASET > &)=0
Read a chunk of data from an existing dataset.
virtual void advance(Writable *, Parameter< Operation::ADVANCE > ¶meters)
Advance the file/stream that this writable belongs to.
Definition: AbstractIOHandlerImpl.hpp:77
virtual void getBufferView(Writable *, Parameter< Operation::GET_BUFFER_VIEW > ¶meters)
Get a view into a dataset buffer that can be filled by a user.
Definition: AbstractIOHandlerImpl.hpp:308
virtual void listAttributes(Writable *, Parameter< Operation::LIST_ATTS > &)=0
List all attributes associated with an object.
virtual void deregister(Writable *, Parameter< Operation::DEREGISTER > const ¶m)=0
Notify the backend that the Writable has been / will be deallocated.
virtual void availableChunks(Writable *, Parameter< Operation::AVAILABLE_CHUNKS > &)=0
Report chunks that are available for loading from the dataset represented by this writable.
virtual void checkFile(Writable *, Parameter< Operation::CHECK_FILE > &)=0
Check if the file specified by the parameter is already present on disk.
virtual void createDataset(Writable *, Parameter< Operation::CREATE_DATASET > const &)=0
Create a new dataset of given type, extent and storage properties.
virtual void closePath(Writable *, Parameter< Operation::CLOSE_PATH > const &)
Close an openPMD group.
Definition: AbstractIOHandlerImpl.hpp:102
virtual void openDataset(Writable *, Parameter< Operation::OPEN_DATASET > &)=0
Open an existing dataset and determine its datatype and extent.
virtual void readAttribute(Writable *, Parameter< Operation::READ_ATT > &)=0
Read the value of an existing attribute.
virtual void createPath(Writable *, Parameter< Operation::CREATE_PATH > const &)=0
Create all necessary groups for a path, possibly recursively.
virtual void openFile(Writable *, Parameter< Operation::OPEN_FILE > &)=0
Open an existing file assuming it conforms to openPMD.
virtual void closeFile(Writable *, Parameter< Operation::CLOSE_FILE > const &)=0
Close the file corresponding with the writable and release file handles.
virtual void listPaths(Writable *, Parameter< Operation::LIST_PATHS > &)=0
List all paths/sub-groups inside a group, non-recursively.
virtual void extendDataset(Writable *, Parameter< Operation::EXTEND_DATASET > const &)=0
Increase the extent of an existing dataset.
virtual void writeAttribute(Writable *, Parameter< Operation::WRITE_ATT > const &)=0
Create a single attribute and fill the value, possibly overwriting an existing attribute.
virtual void deleteAttribute(Writable *, Parameter< Operation::DELETE_ATT > const &)=0
Delete an existing attribute.
virtual void deleteFile(Writable *, Parameter< Operation::DELETE_FILE > const &)=0
Delete an existing file from physical storage.
virtual void createFile(Writable *, Parameter< Operation::CREATE_FILE > const &)=0
Create a new file in physical storage, possibly overriding an existing file.
virtual void listDatasets(Writable *, Parameter< Operation::LIST_DATASETS > &)=0
List all datasets inside a group, non-recursively.
virtual void deletePath(Writable *, Parameter< Operation::DELETE_PATH > const &)=0
Delete all objects within an existing path.
virtual void openPath(Writable *, Parameter< Operation::OPEN_PATH > const &)=0
Open all contained groups in a path, possibly recursively.
Layer to mirror structure of logical data and persistent data in file.
Definition: Writable.hpp:75
An operation was requested that is not supported in a specific backend.
Definition: Error.hpp:50
Public definitions of openPMD-api.
Definition: Date.cpp:29
@ RANDOMACCESS
there is no stream, it will never be over
Definition: IOTask.hpp:597
std::shared_ptr< AdvanceStatus > status
output parameter
Definition: IOTask.hpp:614
Definition: IOTask.hpp:621
Definition: IOTask.hpp:133
Definition: IOTask.hpp:182
Definition: IOTask.hpp:237
Definition: IOTask.hpp:312
Definition: IOTask.hpp:114
Definition: IOTask.hpp:218
Definition: IOTask.hpp:502
Definition: IOTask.hpp:387
Definition: IOTask.hpp:199
Definition: IOTask.hpp:273
Definition: IOTask.hpp:641
Definition: IOTask.hpp:347
Definition: IOTask.hpp:471
Definition: IOTask.hpp:577
Definition: IOTask.hpp:451
Definition: IOTask.hpp:292
Definition: IOTask.hpp:366
Definition: IOTask.hpp:160
Definition: IOTask.hpp:254
Definition: IOTask.hpp:555
Definition: IOTask.hpp:429
Definition: IOTask.hpp:521
Definition: IOTask.hpp:406