openPMD::ReadIterations Class Reference

Legacy class as return type for Series::readIterations(). More...

#include <ReadIterations.hpp>

Public Member Functions
auto	begin () -> iterator_t

Static Public Member Functions
static auto	end () -> iterator_t

Friends
class	Series

Detailed Description

Legacy class as return type for Series::readIterations().

This is a feature-restricted subset for the functionality of Series::snapshots(), prefer using that. The compatibility layer is needed due to the different value_type for Series::readIterations()-based iteration (IndexedIteration instead of std::pair<uint64_t, Iteration>).

Create instance via Series::readIterations(). For use in a C++11-style foreach loop over 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 StatefulIterator::operator++(), i.e. upon going to the next iteration in the foreach loop.

---

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

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