openPMD-api
 
Loading...
Searching...
No Matches
openPMD::internal::BaseRecordComponentData Class Reference
Inheritance diagram for openPMD::internal::BaseRecordComponentData:
openPMD::internal::AttributableData openPMD::internal::RecordComponentData

Public Member Functions

 BaseRecordComponentData (BaseRecordComponentData const &)=delete
 
 BaseRecordComponentData (BaseRecordComponentData &&)=delete
 
BaseRecordComponentDataoperator= (BaseRecordComponentData const &)=delete
 
BaseRecordComponentDataoperator= (BaseRecordComponentData &&)=delete
 
virtual void reset ()
 
- Public Member Functions inherited from openPMD::internal::AttributableData
 AttributableData (SharedAttributableData *)
 
 AttributableData (AttributableData const &)=delete
 
 AttributableData (AttributableData &&)=delete
 
AttributableDataoperator= (AttributableData const &)=delete
 
AttributableDataoperator= (AttributableData &&)=delete
 
void cloneFrom (AttributableData const &other)
 
template<typename T>
T asInternalCopyOf ()
 
auto attributes () -> A_MAP &
 
auto attributes () const -> A_MAP const &
 
auto readAttribute (std::string const &name) const -> Attribute const &
 

Public Attributes

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.
 
bool m_datasetDefined = false
 Tracks if there was any write access to the record component.
 

Member Data Documentation

◆ m_datasetDefined

bool openPMD::internal::BaseRecordComponentData::m_datasetDefined = false

Tracks if there was any write access to the record component.

Necessary in BaseRecord<T> to track if the scalar component has been used and is used by BaseRecord<T> to determine the return value of the BaseRecord<T>::scalar() method.

◆ m_isConstant

bool openPMD::internal::BaseRecordComponentData::m_isConstant = false

True if this is defined as a constant record component as specified in the openPMD standard.

If yes, then no heavy-weight dataset is created and the dataset is instead defined via light-weight attributes.


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