openPMD::StatefulIterator Class Reference

Based on the logic of the former class ReadIterations, integrating into itself the logic of former WriteIterations. More...

#include <StatefulIterator.hpp>

Inheritance diagram for openPMD::StatefulIterator:

Classes
class	tag_read_t
class	tag_write_t

Public Types
using	value_type
using	Seek = detail::Seek
Public Types inherited from openPMD::AbstractSeriesIterator< StatefulIterator, Container< Iteration, Iteration::IterationIndex_t >::value_type >
using	difference_type
using	value_type
Public Types inherited from openPMD::DynamicSeriesIterator< value_type >
using	difference_type = Iteration::IterationIndex_t

Public Member Functions
	StatefulIterator ()
	construct the end() iterator
	StatefulIterator (StatefulIterator const &other)
	StatefulIterator (StatefulIterator &&other) noexcept
StatefulIterator &	operator= (StatefulIterator const &other)
StatefulIterator &	operator= (StatefulIterator &&other) noexcept
	StatefulIterator (tag_read_t, Series const &, std::optional< internal::ParsePreference > const &parsePreference)
	StatefulIterator (tag_write_t, Series const &)
auto	operator* () -> value_type &
auto	operator* () const -> value_type const &
auto	operator++ () -> StatefulIterator &
auto	operator-- () -> StatefulIterator &
auto	operator-- (int) -> StatefulIterator
auto	operator++ (int) -> StatefulIterator
auto	operator- (StatefulIterator const &) const -> difference_type
bool	operator== (StatefulIterator const &other) const
auto	operator< (StatefulIterator const &) const -> bool
auto	is_end () const -> bool
	operator bool () const
auto	seek (Seek const &) -> StatefulIterator &
Public Member Functions inherited from openPMD::AbstractSeriesIterator< StatefulIterator, Container< Iteration, Iteration::IterationIndex_t >::value_type >
auto	operator-> () const -> value_type const *
auto	operator-> () -> value_type *
auto	default_increment_operator (int) -> StatefulIterator
auto	default_decrement_operator (int) -> StatefulIterator
bool	operator!= (StatefulIterator const &) const
auto	operator-> () const -> value_type const *
auto	operator-> () -> value_type *
auto	default_increment_operator (int) -> StatefulIterator
auto	default_decrement_operator (int) -> StatefulIterator
bool	operator!= (StatefulIterator const &) const

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

Static Public Attributes
static constexpr tag_write_t const	tag_write {}
static constexpr tag_read_t const	tag_read {}

Friends
class	StatefulSnapshotsContainer
class	Series
class	internal::SeriesData

Additional Inherited Members
Protected Types inherited from openPMD::AbstractSeriesIterator< StatefulIterator, Container< Iteration, Iteration::IterationIndex_t >::value_type >
using	parent_t
Protected Member Functions inherited from openPMD::AbstractSeriesIterator< StatefulIterator, Container< Iteration, Iteration::IterationIndex_t >::value_type >
auto	dereference_operator () const -> value_type const &override
auto	increment_operator () -> parent_t &override
auto	decrement_operator () -> parent_t &override
auto	equality_operator (parent_t const &) const -> bool override
auto	clone () const -> std::unique_ptr< parent_t > override
virtual Container< Iteration, Iteration::IterationIndex_t >::value_type &	dereference_operator ()
auto	dereference_operator () const -> value_type const &override
virtual Container< Iteration, Iteration::IterationIndex_t >::value_type &	dereference_operator ()
auto	increment_operator () -> parent_t &override
auto	decrement_operator () -> parent_t &override
auto	equality_operator (parent_t const &) const -> bool override
auto	clone () const -> std::unique_ptr< parent_t > override
Protected Member Functions inherited from openPMD::DynamicSeriesIterator< value_type >
virtual bool	equality_operator (DynamicSeriesIterator const &) const =0

Detailed Description

Based on the logic of the former class ReadIterations, integrating into itself the logic of former WriteIterations.

Member Typedef Documentation

value_type

using openPMD::StatefulIterator::value_type

Initial value:

 
        typename Container<Iteration, Iteration::IterationIndex_t>::value_type

---

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

• /tmp/tmp.NhLRcLhrNZ/openPMD-api/include/openPMD/snapshots/StatefulIterator.hpp
• /tmp/tmp.NhLRcLhrNZ/openPMD-api/src/snapshots/StatefulIterator.cpp