openPMD-api
Public Attributes | List of all members
openPMD::internal::IterationData Class Reference
Inheritance diagram for openPMD::internal::IterationData:
Inheritance graph
[legend]
Collaboration diagram for openPMD::internal::IterationData:
Collaboration graph
[legend]

Public Attributes

CloseStatus m_closed = CloseStatus::Open
 
StepStatus m_stepStatus = StepStatus::NoStep
 Whether a step is currently active for this iteration. More...
 
std::optional< DeferredParseAccessm_deferredParseAccess {}
 Information on a parsing request that has not yet been executed. More...
 
std::optional< std::string > m_overrideFilebasedFilename {}
 Upon reading a file, set this field to the used file name. More...
 
- Public Attributes inherited from openPMD::internal::AttributableData
Writable m_writable
 The Writable associated with this Attributable. More...
 

Additional Inherited Members

- Public Types inherited from openPMD::internal::AttributableData
using A_MAP = std::map< std::string, Attribute >
 
- Public Member Functions inherited from openPMD::internal::AttributableData
 AttributableData (AttributableData const &)=delete
 
 AttributableData (AttributableData &&)=delete
 
AttributableDataoperator= (AttributableData const &)=delete
 
AttributableDataoperator= (AttributableData &&)=delete
 

Member Data Documentation

◆ m_deferredParseAccess

std::optional<DeferredParseAccess> openPMD::internal::IterationData::m_deferredParseAccess {}

Information on a parsing request that has not yet been executed.

Otherwise empty.

◆ m_overrideFilebasedFilename

std::optional<std::string> openPMD::internal::IterationData::m_overrideFilebasedFilename {}

Upon reading a file, set this field to the used file name.

In inconsistent iteration paddings, we must remember the name of the file since it cannot be reconstructed from the filename pattern alone.

◆ m_stepStatus

StepStatus openPMD::internal::IterationData::m_stepStatus = StepStatus::NoStep

Whether a step is currently active for this iteration.

Used for file-based iteration layout, see Series.hpp for group-based layout. Access via stepStatus() method to automatically select the correct one among both flags.


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