hipo::hipoeventfile::iterator Class Reference

Input iterator for traversing events in a hipoeventfile. More...

#include <hipoeventiterator.h>

Public Types
using	iterator_category = std::input_iterator_tag
using	value_type = iter_event
using	reference = iter_event &
using	pointer = iter_event *

Public Member Functions
	iterator ()
	Construct an end-of-file sentinel iterator. More...
iterator &	operator++ ()
	Increment operator; advance to the next event. More...
reference	operator* ()
	Dereference operator; get a reference to the current event wrapper. More...
pointer	operator-> ()
	Member access operator; get a pointer to the current event wrapper. More...
bool	operator!= (const iterator &other) const
	Inequality comparison operator. More...
bool	operator== (const iterator &other) const
	Equality comparison operator. More...

Friends
class	hipoeventfile

Detailed Description

Input iterator for traversing events in a hipoeventfile.

Definition at line 109 of file hipoeventiterator.h.

Member Typedef Documentation

iterator_category

using hipo::hipoeventfile::iterator::iterator_category = std::input_iterator_tag

Definition at line 113 of file hipoeventiterator.h.

pointer

using hipo::hipoeventfile::iterator::pointer = iter_event*

Definition at line 116 of file hipoeventiterator.h.

reference

using hipo::hipoeventfile::iterator::reference = iter_event&

Definition at line 115 of file hipoeventiterator.h.

value_type

using hipo::hipoeventfile::iterator::value_type = iter_event

Definition at line 114 of file hipoeventiterator.h.

Constructor & Destructor Documentation

iterator()

hipo::hipoeventfile::iterator::iterator ( )

inline

Construct an end-of-file sentinel iterator.

Definition at line 137 of file hipoeventiterator.h.

Member Function Documentation

operator!=()

bool hipo::hipoeventfile::iterator::operator!= ( const iterator &  other ) const

inline

Inequality comparison operator.

Parameters

other

Iterator to compare with.

Returns

True if iterators are not at the same position.

Definition at line 165 of file hipoeventiterator.h.

operator*()

reference hipo::hipoeventfile::iterator::operator* ( )

inline

Dereference operator; get a reference to the current event wrapper.

Returns

Reference to the current iter_event.

Definition at line 156 of file hipoeventiterator.h.

operator++()

iterator& hipo::hipoeventfile::iterator::operator++ ( )

inline

Increment operator; advance to the next event.

Returns

Reference to this iterator.

Definition at line 141 of file hipoeventiterator.h.

operator->()

pointer hipo::hipoeventfile::iterator::operator-> ( )

inline

Member access operator; get a pointer to the current event wrapper.

Returns

Pointer to the current iter_event.

Definition at line 160 of file hipoeventiterator.h.

operator==()

bool hipo::hipoeventfile::iterator::operator== ( const iterator &  other ) const

inline

Equality comparison operator.

Parameters

other

Iterator to compare with.

Returns

True if iterators are at the same position.

Definition at line 170 of file hipoeventiterator.h.

Friends And Related Function Documentation

hipoeventfile

friend class hipoeventfile

friend

Definition at line 110 of file hipoeventiterator.h.

---

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

• hipo4/hipoeventiterator.h