openPMD::ReadIterations Class Reference

Reading side of the streaming API. More...

#include <ReadIterations.hpp>

Public Member Functions
iterator_t	begin ()
iterator_t	end ()

Friends
class	Series

Detailed Description

Reading side of the streaming API.

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 SeriesIterator::operator++(), i.e. upon going to the next iteration in the foreach loop. 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:

• /tmp/tmp.7iNmvGSbic/openPMD-api/include/openPMD/ReadIterations.hpp
• /tmp/tmp.7iNmvGSbic/openPMD-api/src/ReadIterations.cpp