openPMD-api
|
Public Member Functions | |
BaseRecordComponent (BaseRecordComponent const &other) | |
BaseRecordComponent (BaseRecordComponent &&other) | |
BaseRecordComponent & | operator= (BaseRecordComponent const &other) |
BaseRecordComponent & | operator= (BaseRecordComponent &&other) |
double | unitSI () const |
BaseRecordComponent & | resetDatatype (Datatype) |
Datatype | getDatatype () const |
bool | constant () const |
Returns true if this is a constant record component. More... | |
std::optional< size_t > | joinedDimension () const |
ChunkTable | availableChunks () |
Get data chunks that are available to be loaded from the backend. More... | |
Public Member Functions inherited from openPMD::Attributable | |
Attributable (NoInit) | |
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... | |
Attributable & | setComment (std::string const &comment) |
Populate Attribute corresponding to a comment with the user-supplied comment. More... | |
void | seriesFlush (std::string backendConfig="{}") |
Flush the corresponding Series object. More... | |
MyPath | myPath () const |
The path to this object within its containing Series. More... | |
protected Series | retrieveSeries () const |
void | seriesFlush (internal::FlushParams const &) |
void | flushAttributes (internal::FlushParams const &) |
void | readAttributes (ReadMode) |
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< T > | readVectorFloatingpoint (std::string const &key) const |
Retrieve a vector of values of a floating point Attributes of user-defined precision with ensured type-safety. More... | |
AbstractIOHandler * | IOHandler () |
AbstractIOHandler const * | IOHandler () const |
Writable *& | parent () |
Writable const * | parent () const |
Writable & | writable () |
Writable const & | writable () const |
void | setData (std::shared_ptr< internal::AttributableData > attri) |
internal::AttributableData & | get () |
internal::AttributableData const & | get () const |
bool | dirty () const |
bool | dirtyRecursive () const |
O(1). | |
void | setDirty (bool dirty_in) |
void | setDirtyRecursive (bool dirty_in) |
bool | written () const |
bool & | written () |
template<typename T > | |
bool | setAttribute (std::string const &key, T value) |
Populate Attribute of provided name with provided value. More... | |
bool | setAttribute (std::string const &key, char const value[]) |
Iteration const & | containingIteration () const |
Returns the corresponding Iteration. More... | |
Iteration & | containingIteration () |
Protected Types | |
using | Data_t = internal::BaseRecordComponentData |
Protected Types inherited from openPMD::Attributable | |
using | Data_t = internal::AttributableData |
Protected Member Functions | |
Data_t const & | get () const |
Data_t & | get () |
void | setData (std::shared_ptr< Data_t > data) |
virtual void | setDatasetDefined (Data_t &) |
bool | datasetDefined () const |
BaseRecordComponent (NoInit) | |
Protected Attributes | |
std::shared_ptr< Data_t > | m_baseRecordComponentData |
Protected Attributes inherited from openPMD::Attributable | |
std::shared_ptr< Data_t > | m_attri |
Friends | |
template<typename T , typename T_key , typename T_container > | |
class | Container |
Additional Inherited Members | |
Public Types inherited from openPMD::Attributable | |
enum | ReadMode { IgnoreExisting , OverrideExisting , FullyReread } |
ChunkTable openPMD::BaseRecordComponent::availableChunks | ( | ) |
Get data chunks that are available to be loaded from the backend.
Note that this is backend-dependent information and the returned information may hence differ between different backends:
The results depend solely on the backend and are independent of any openPMD-related information. Note that this call currently does not take into account the openPMD concept of particle patches, which users may additionally wish to use to store user-defined, backend-independent chunking information on particle datasets.
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.