openPMD::WriteIterations Class Reference

Writing side of the streaming API. More...

#include <WriteIterations.hpp>

Public Types
using	key_type = IterationsContainer_t::key_type
using	mapped_type = IterationsContainer_t::mapped_type
using	value_type = IterationsContainer_t::value_type
using	reference = IterationsContainer_t::reference

Public Member Functions
mapped_type &	operator[] (key_type const &key)
mapped_type &	operator[] (key_type &&key)
std::optional< IndexedIteration >	currentIteration ()
	Return the iteration that is currently being written to, if it exists.

Friends
class	Series
class	internal::SeriesData

Detailed Description

Writing side of the streaming API.

Create instance via Series::writeIterations(). Restricted Container of Iterations, designed to allow reading any kind of Series, streaming and non-streaming alike. Calling Iteration::close() manually before opening the next iteration is encouraged and will implicitly flush all deferred IO actions. Otherwise, Iteration::close() will be implicitly called upon opening the next iteration or upon destruction. Since this is designed for streaming mode, reopening an iteration is not possible once it has been closed.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/openpmd-api/checkouts/latest/include/openPMD/WriteIterations.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/openpmd-api/checkouts/latest/src/WriteIterations.cpp