openPMD-api
|
#include <PatchRecordComponent.hpp>
Public Member Functions | |
PatchRecordComponent & | setUnitSI (double) |
PatchRecordComponent & | resetDataset (Dataset) |
uint8_t | getDimensionality () const |
Extent | getExtent () const |
template<typename T > | |
std::shared_ptr< T > | load () |
template<typename T > | |
void | load (std::shared_ptr< T >) |
template<typename T > | |
void | load (std::shared_ptr< T[]>) |
template<typename T > | |
void | loadRaw (T *) |
template<typename T > | |
void | store (uint64_t idx, T) |
private void | flush (std::string const &, internal::FlushParams const &) |
void | read () |
bool | dirtyRecursive () const |
Check recursively whether this RecordComponent is dirty. More... | |
protected | PatchRecordComponent (std::shared_ptr< internal::PatchRecordComponentData >) |
internal::PatchRecordComponentData const & | get () const |
internal::PatchRecordComponentData & | get () |
void | setData (std::shared_ptr< internal::PatchRecordComponentData > data) |
![]() | |
double | unitSI () const |
BaseRecordComponent & | resetDatatype (Datatype) |
Datatype | getDatatype () const |
bool | constant () const |
Returns true if this is a constant record component. More... | |
ChunkTable | availableChunks () |
Get data chunks that are available to be loaded from the backend. More... | |
![]() | |
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) |
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 & | dirty () |
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 () |
Public Attributes | |
std::shared_ptr< internal::PatchRecordComponentData > | m_patchRecordComponentData {new internal::PatchRecordComponentData()} |
Additional Inherited Members | |
![]() | |
enum | ReadMode { IgnoreExisting, OverrideExisting, FullyReread } |
![]() | |
internal::BaseRecordComponentData const & | get () const |
internal::BaseRecordComponentData & | get () |
void | setData (std::shared_ptr< internal::BaseRecordComponentData > data) |
BaseRecordComponent (std::shared_ptr< internal::BaseRecordComponentData >) | |
![]() | |
Attributable (std::shared_ptr< internal::AttributableData >) | |
![]() | |
std::shared_ptr< internal::BaseRecordComponentData > | m_baseRecordComponentData {new internal::BaseRecordComponentData()} |
![]() | |
std::shared_ptr< internal::AttributableData > | m_attri |
bool openPMD::PatchRecordComponent::dirtyRecursive | ( | ) | const |
Check recursively whether this RecordComponent is dirty.
It is dirty if any attribute or dataset is read from or written to the backend.
|
inline |