Public Types | Public Attributes | Friends | List of all members
openPMD::IndexedIteration Class Reference

Subclass of Iteration that knows its own index withing the containing Series. More...

#include <ReadIterations.hpp>

Inheritance diagram for openPMD::IndexedIteration:
Inheritance graph
Collaboration diagram for openPMD::IndexedIteration:
Collaboration graph

Public Types

using iterations_t = decltype(internal::SeriesData::iterations)
using index_t = iterations_t::key_type

Public Attributes

const index_t iterationIndex
- Public Attributes inherited from openPMD::Iteration
Container< Meshmeshes
Container< ParticleSpeciesparticles


class SeriesIterator

Additional Inherited Members

- Public Member Functions inherited from openPMD::Iteration
 Iteration (Iteration const &)=default
Iterationoperator= (Iteration const &)=default
template<typename T >
time () const
template<typename T >
IterationsetTime (T newTime)
 Set the global reference time for this iteration. More...
template<typename T >
dt () const
template<typename T >
IterationsetDt (T newDt)
 Set the time step used to reach this iteration. More...
double timeUnitSI () const
IterationsetTimeUnitSI (double newTimeUnitSI)
 Set the conversion factor to convert time and dt to seconds. More...
Iterationclose (bool flush=true)
 Close an iteration. More...
Iterationopen ()
 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::AttributableInterface
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...
AttributableInterfacesetComment (std::string const &comment)
 Populate Attribute corresponding to a comment with the user-supplied comment. More...
void seriesFlush ()
 Flush the corresponding Series object. More...
MyPath myPath () const
 The path to this object within its containing Series. More...
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[])
- Protected Types inherited from openPMD::AttributableInterface
enum  ReadMode { IgnoreExisting, OverrideExisting, FullyReread }
- Protected Member Functions inherited from openPMD::AttributableInterface
 AttributableInterface (internal::AttributableData *)
template<typename T >
 AttributableInterface (T *attri)
const internal::SeriesInternalretrieveSeries () const
internal::SeriesInternalretrieveSeries ()
void seriesFlush (FlushLevel)
void flushAttributes ()
void readAttributes (ReadMode)
template<typename 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...
AbstractIOHandlerIOHandler ()
const AbstractIOHandlerIOHandler () const
Writable *& parent ()
const Writableparent () const
Writablewritable ()
const Writablewritable () const
internal::AttributableDataget ()
const internal::AttributableDataget () const
bool dirty () const
bool & dirty ()
bool written () const
bool & written ()
const IterationcontainingIteration () const
 Returns the corresponding Iteration. More...
IterationcontainingIteration ()
- Protected Attributes inherited from openPMD::LegacyAttributable
std::shared_ptr< internal::AttributableDatam_attributableData
- Protected Attributes inherited from openPMD::AttributableInterface
internal::AttributableDatam_attri = nullptr

Detailed Description

Subclass of Iteration that knows its own index withing the containing Series.

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