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

Public Member Functions

 RecordComponentData (RecordComponentData const &)=delete
 
 RecordComponentData (RecordComponentData &&)=delete
 
RecordComponentDataoperator= (RecordComponentData const &)=delete
 
RecordComponentDataoperator= (RecordComponentData &&)=delete
 
void push_chunk (IOTask &&task)
 
void reset () override
 
- Public Member Functions inherited from openPMD::internal::BaseRecordComponentData
 BaseRecordComponentData (BaseRecordComponentData const &)=delete
 
 BaseRecordComponentData (BaseRecordComponentData &&)=delete
 
BaseRecordComponentDataoperator= (BaseRecordComponentData const &)=delete
 
BaseRecordComponentDataoperator= (BaseRecordComponentData &&)=delete
 
- Public Member Functions inherited from openPMD::internal::AttributableData
 AttributableData (AttributableData const &)=delete
 
 AttributableData (AttributableData &&)=delete
 
AttributableDataoperator= (AttributableData const &)=delete
 
AttributableDataoperator= (AttributableData &&)=delete
 

Public Attributes

std::queue< IOTaskm_chunks
 Chunk reading/writing requests on the contained dataset.
 
Attribute m_constantValue {-1}
 Stores the value for constant record components. More...
 
std::string m_name
 The same std::string that the parent class would pass as parameter to RecordComponent::flush(). More...
 
bool m_isEmpty = false
 True if this component is an empty dataset, i.e. More...
 
bool m_hasBeenExtended = false
 User has extended the dataset, but the EXTEND task must yet be flushed to the backend.
 
- Public Attributes inherited from openPMD::internal::BaseRecordComponentData
std::optional< Datasetm_dataset
 The type and extent of the dataset defined by this component.
 
bool m_isConstant = false
 True if this is defined as a constant record component as specified in the openPMD standard. More...
 
bool m_datasetDefined = false
 Tracks if there was any write access to the record component. 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 >
 

Member Data Documentation

◆ m_constantValue

Attribute openPMD::internal::RecordComponentData::m_constantValue {-1}

Stores the value for constant record components.

Ignored otherwise.

◆ m_isEmpty

bool openPMD::internal::RecordComponentData::m_isEmpty = false

True if this component is an empty dataset, i.e.

its extent is zero in at least one dimension. Treated by the openPMD-api as a special case of constant record components.

◆ m_name

std::string openPMD::internal::RecordComponentData::m_name

The same std::string that the parent class would pass as parameter to RecordComponent::flush().

This is stored only upon RecordComponent::flush() if AbstractIOHandler::flushLevel is set to FlushLevel::SkeletonOnly (for use by the Span<T>-based overload of RecordComponent::storeChunk()).

Todo:
Merge functionality with ownKeyInParent?

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