openPMD-api
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Friends | List of all members
openPMD::OpaqueSeriesIterator< value_type_in > Class Template Reference

Counterpart to Snapshots class: Iterator type that can wrap different implementations internally. More...

#include <ContainerTraits.hpp>

Inheritance diagram for openPMD::OpaqueSeriesIterator< value_type_in >:
Inheritance graph
[legend]
Collaboration diagram for openPMD::OpaqueSeriesIterator< value_type_in >:
Collaboration graph
[legend]

Public Types

using value_type = value_type_in
 
- Public Types inherited from openPMD::AbstractSeriesIterator< OpaqueSeriesIterator< value_type_in >, value_type_in >
using difference_type = Iteration::IterationIndex_t
 
using value_type = value_type_in
 
- Public Types inherited from openPMD::DynamicSeriesIterator< value_type >
using difference_type = Iteration::IterationIndex_t
 

Public Member Functions

 OpaqueSeriesIterator (std::unique_ptr< DynamicSeriesIterator< value_type_in >> internal_iterator)
 
 OpaqueSeriesIterator (OpaqueSeriesIterator const &other)
 
 OpaqueSeriesIterator (OpaqueSeriesIterator &&other) noexcept
 
OpaqueSeriesIterator & operator= (OpaqueSeriesIterator const &other)
 
OpaqueSeriesIterator & operator= (OpaqueSeriesIterator &&other) noexcept
 
auto operator* () -> value_type &
 
auto operator* () const -> value_type const &
 
OpaqueSeriesIterator & operator++ ()
 
OpaqueSeriesIterator & operator-- ()
 Not implemented for synchronous workflow: Reverse iteration not possible.
 
OpaqueSeriesIterator operator++ (int)
 Not implemented for synchronous workflow: Post increment not possible.
 
OpaqueSeriesIterator operator-- (int)
 Not implemented for synchronous workflow: Reverse iteration not possible.
 
bool operator== (OpaqueSeriesIterator const &other) const
 
- Public Member Functions inherited from openPMD::AbstractSeriesIterator< OpaqueSeriesIterator< value_type_in >, value_type_in >
auto operator-> () const -> value_type const *
 
auto operator-> () -> value_type *
 
auto default_increment_operator (int) -> OpaqueSeriesIterator< value_type_in >
 
auto default_decrement_operator (int) -> OpaqueSeriesIterator< value_type_in >
 
bool operator!= (OpaqueSeriesIterator< value_type_in > const &) const
 

Protected Types

using Self_t = OpaqueSeriesIterator< value_type_in >
 
- Protected Types inherited from openPMD::AbstractSeriesIterator< OpaqueSeriesIterator< value_type_in >, value_type_in >
using parent_t = DynamicSeriesIterator< value_type_in >
 

Protected Member Functions

template<typename ChildClass >
auto to_concrete_iterator () -> std::optional< ChildClass >
 
- Protected Member Functions inherited from openPMD::AbstractSeriesIterator< OpaqueSeriesIterator< value_type_in >, value_type_in >
auto dereference_operator () const -> value_type const &override
 
virtual value_type const & dereference_operator () const =0
 
virtual 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
 

Friends

class Series
 
class StatefulSnapshotsContainer
 
class RandomAccessIteratorContainer
 

Detailed Description

template<typename value_type_in>
class openPMD::OpaqueSeriesIterator< value_type_in >

Counterpart to Snapshots class: Iterator type that can wrap different implementations internally.


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