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

Public Member Functions

double unitSI () const
 
BaseRecordComponentresetDatatype (Datatype)
 
Datatype getDatatype () const
 
bool constant () const
 Returns true if this is a constant record component. More...
 
- Public Member Functions inherited from openPMD::Attributable
 Attributable (Attributable const &)
 
 Attributable (Attributable &&)=delete
 
Attributableoperator= (Attributable const &)
 
Attributableoperator= (Attributable &&)=delete
 
Attribute getAttribute (std::string const &key) const
 Retrieve value of Attribute stored with provided key. More...
 
bool deleteAttribute (std::string const &key)
 Remove Attribute of provided value both logically and physically. More...
 
std::vector< std::string > attributes () const
 List all currently stored Attributes' keys. More...
 
size_t numAttributes () const
 Count all currently stored Attributes. More...
 
bool containsAttribute (std::string const &key) const
 Check whether am Attribute with a given key exists. More...
 
std::string comment () const
 Retrieve a user-supplied comment associated with the object. More...
 
AttributablesetComment (std::string const &comment)
 Populate Attribute corresponding to a comment with the user-supplied comment. More...
 
template<typename T >
bool setAttribute (std::string const &key, T const &value)
 Populate Attribute of provided name with provided value. More...
 
bool setAttribute (std::string const &key, char const value[])
 

Protected Attributes

std::shared_ptr< Datasetm_dataset
 
std::shared_ptr< bool > m_isConstant
 
- Protected Attributes inherited from openPMD::Attributable
std::shared_ptr< Writablem_writable
 
AbstractFilePositionabstractFilePosition
 
AbstractIOHandlerIOHandler
 
Writableparent
 

Friends

template<typename T , typename T_key , typename T_container >
class Container
 

Additional Inherited Members

- Protected Member Functions inherited from openPMD::Attributable
void flushAttributes ()
 
void readAttributes ()
 
template<typename T >
T readFloatingpoint (std::string const &key) const
 Retrieve the value of a floating point Attribute of user-defined precision with ensured type-safety. More...
 
template<typename T >
std::vector< TreadVectorFloatingpoint (std::string const &key) const
 Retrieve a vector of values of a floating point Attributes of user-defined precision with ensured type-safety. More...
 
bool & dirty () const
 
bool & written () const
 

Member Function Documentation

◆ constant()

bool openPMD::BaseRecordComponent::constant ( ) const

Returns true if this is a constant record component.

In a constant record component, the value for each date in its extent is the same.

Returns
true if a constant record component

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