openPMD-api
 
Loading...
Searching...
No Matches
openPMD::Writable Class Referencefinal

Layer to mirror structure of logical data and persistent data in file. More...

#include <Writable.hpp>

Public Member Functions

 Writable (Writable const &other)=delete
 
 Writable (Writable &&other)=delete
 
Writableoperator= (Writable const &other)=delete
 
Writableoperator= (Writable &&other)=delete
 
template<bool flush_entire_series>
void seriesFlush (std::string backendConfig="{}")
 Flush the corresponding Series object.
 

Friends

class internal::SharedAttributableData
 
class internal::AttributableData
 
class internal::SeriesData
 
class Attributable
 
template<typename T_elem>
class BaseRecord
 
template<typename T_elem>
class BaseRecordInterface
 
template<typename T, typename T_key, typename T_container>
class Container
 
class Iteration
 
class Mesh
 
class ParticleSpecies
 
class Series
 
class Record
 
class RecordComponent
 
class AbstractIOHandlerImpl
 
class ADIOS2IOHandlerImpl
 
class detail::ADIOS2File
 
class HDF5IOHandlerImpl
 
class ParallelHDF5IOHandlerImpl
 
template<typename>
class AbstractIOHandlerImplCommon
 
class JSONIOHandlerImpl
 
struct test::TestHelper
 
template<typename>
class Span
 
struct Parameter< Operation::CREATE_DATASET >
 
struct Parameter< Operation::OPEN_DATASET >
 
std::string concrete_h5_file_position (Writable *w)
 
std::string concrete_bp1_file_position (Writable *)
 
void debug::printDirty (Series const &)
 

Detailed Description

Layer to mirror structure of logical data and persistent data in file.

Hierarchy of objects (datasets, groups, attributes, ...) in openPMD is managed in this class. It also indicates the current synchronization state between logical and persistent data: - whether the object has been created in persistent form

  • whether the logical object has been modified compared to last persistent state

Member Function Documentation

◆ seriesFlush()

template<bool flush_entire_series>
template void openPMD::Writable::seriesFlush< false > ( std::string backendConfig = "{}")

Flush the corresponding Series object.

Writable connects all objects of an openPMD series through a linked list of parents. This method will walk up the parent list until it reaches an object that has no parent, which is the Series object, and flush()-es it.


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