openPMD-api
|
Subclass of Iteration that knows its own index withing the containing Series. More...
#include <Iteration.hpp>
Public Types | |
using | index_t = Iteration::IterationIndex_t |
Public Types inherited from openPMD::Iteration | |
using | IterationIndex_t = uint64_t |
Public Types inherited from openPMD::Attributable | |
enum | ReadMode { IgnoreExisting , OverrideExisting , FullyReread } |
Public Attributes | |
index_t const | iterationIndex |
Public Attributes inherited from openPMD::Iteration | |
Container< Mesh > | meshes {} |
Container< ParticleSpecies > | particles {} |
Friends | |
class | SeriesIterator |
class | WriteIterations |
Additional Inherited Members | |
Public Member Functions inherited from openPMD::Iteration | |
Iteration (Iteration const &)=default | |
Iteration & | operator= (Iteration const &)=default |
template<typename T > | |
T | time () const |
template<typename T > | |
Iteration & | setTime (T newTime) |
Set the global reference time for this iteration. More... | |
template<typename T > | |
T | dt () const |
template<typename T > | |
Iteration & | setDt (T newDt) |
Set the time step used to reach this iteration. More... | |
double | timeUnitSI () const |
Iteration & | setTimeUnitSI (double newTimeUnitSI) |
Set the conversion factor to convert time and dt to seconds. More... | |
Iteration & | close (bool flush=true) |
Close an iteration. More... | |
Iteration & | open () |
Open an iteration. More... | |
bool | closed () const |
Has the iteration been closed? A closed iteration may not (yet) be reopened. More... | |
bool | closedByWriter () const |
Has the iteration been closed by the writer? Background: Upon calling Iteration::close(), the openPMD API will add metadata to the iteration in form of an attribute, indicating that the iteration has indeed been closed. 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 inherited from openPMD::Attributable | |
using | Data_t = internal::AttributableData |
Protected Attributes inherited from openPMD::Attributable | |
std::shared_ptr< Data_t > | m_attri |