helios::ecs::EventIterator< T > Class Template Reference

Iterator wrapper for EventReader. More...

#include <event_reader.hpp>

Public Types
using	value_type = std::tuple< std::remove_cvref_t< T > >
using	iterator_category = std::forward_iterator_tag
using	difference_type = ptrdiff_t
using	pointer = const std::tuple< std::remove_cvref_t< T > > *
using	reference = std::tuple< std::remove_cvref_t< T > >

Public Member Functions
constexpr	EventIterator () noexcept=default
constexpr	EventIterator (typename std::vector< std::remove_cvref_t< T > >::const_iterator iter) noexcept
constexpr	EventIterator (const EventIterator &) noexcept=default
constexpr	EventIterator (EventIterator &&) noexcept=default
constexpr	~EventIterator () noexcept=default
constexpr EventIterator &	operator= (const EventIterator &) noexcept=default
constexpr EventIterator &	operator= (EventIterator &&) noexcept=default
constexpr reference	operator* () const noexcept
constexpr EventIterator &	operator++ () noexcept
constexpr EventIterator	operator++ (int) noexcept
constexpr EventIterator &	operator-- () noexcept
constexpr EventIterator	operator-- (int) noexcept
constexpr bool	operator== (const EventIterator &other) const noexcept
constexpr bool	operator!= (const EventIterator &other) const noexcept

Detailed Description

template<EventTrait T>
class helios::ecs::EventIterator< T >

Iterator wrapper for EventReader.

Template Parameters

T	Event type

Definition at line 90 of file event_reader.hpp.

Member Typedef Documentation

difference_type

template<EventTrait T>

using helios::ecs::EventIterator< T >::difference_type = ptrdiff_t

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 94 of file event_reader.hpp.

iterator_category

template<EventTrait T>

using helios::ecs::EventIterator< T >::iterator_category = std::forward_iterator_tag

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 93 of file event_reader.hpp.

pointer

template<EventTrait T>

using helios::ecs::EventIterator< T >::pointer = const std::tuple<std::remove_cvref_t<T> >*

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 95 of file event_reader.hpp.

reference

template<EventTrait T>

using helios::ecs::EventIterator< T >::reference = std::tuple<std::remove_cvref_t<T> >

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 96 of file event_reader.hpp.

value_type

template<EventTrait T>

using helios::ecs::EventIterator< T >::value_type = std::tuple<std::remove_cvref_t<T> >

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 92 of file event_reader.hpp.

Constructor & Destructor Documentation

EventIterator() [1/4]

template<EventTrait T>

constexpr helios::ecs::EventIterator< T >::EventIterator ( )

constexprdefaultnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

EventIterator() [2/4]

template<EventTrait T>

constexpr helios::ecs::EventIterator< T >::EventIterator ( typename std::vector< std::remove_cvref_t< T > >::const_iterator  iter )

inlineexplicitconstexprnoexcept

Definition at line 99 of file event_reader.hpp.

      : iter_(iter) {}

EventIterator() [3/4]

template<EventTrait T>

constexpr helios::ecs::EventIterator< T >::EventIterator ( const EventIterator< T > &  )

constexprdefaultnoexcept

EventIterator() [4/4]

template<EventTrait T>

constexpr helios::ecs::EventIterator< T >::EventIterator ( EventIterator< T > &&  )

constexprdefaultnoexcept

~EventIterator()

template<EventTrait T>

constexpr helios::ecs::EventIterator< T >::~EventIterator ( )

constexprdefaultnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Member Function Documentation

operator!=()

template<EventTrait T>

constexpr bool helios::ecs::EventIterator< T >::operator!= ( const EventIterator< T > &  other ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 118 of file event_reader.hpp.

{ return iter_ != other.iter_; }

operator*()

template<EventTrait T>

constexpr reference helios::ecs::EventIterator< T >::operator* ( ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 109 of file event_reader.hpp.

{ return *iter_; }

operator++() [1/2]

template<EventTrait T>

constexpr auto helios::ecs::EventIterator< T >::operator++ ( )

constexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 125 of file event_reader.hpp.

                                                                       {
  ++iter_;
  return *this;
}

operator++() [2/2]

template<EventTrait T>

constexpr auto helios::ecs::EventIterator< T >::operator++ ( int  )

constexprnoexcept

Definition at line 131 of file event_reader.hpp.

                                                                         {
  auto temp = *this;
  ++iter_;
  return temp;
}

operator--() [1/2]

template<EventTrait T>

constexpr auto helios::ecs::EventIterator< T >::operator-- ( )

constexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 138 of file event_reader.hpp.

                                                                       {
  --iter_;
  return *this;
}

operator--() [2/2]

template<EventTrait T>

constexpr auto helios::ecs::EventIterator< T >::operator-- ( int  )

constexprnoexcept

Definition at line 144 of file event_reader.hpp.

                                                                         {
  auto temp = *this;
  --iter_;
  return temp;
}

operator=() [1/2]

template<EventTrait T>

constexpr EventIterator & helios::ecs::EventIterator< T >::operator= ( const EventIterator< T > &  )

constexprdefaultnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

operator=() [2/2]

template<EventTrait T>

constexpr EventIterator & helios::ecs::EventIterator< T >::operator= ( EventIterator< T > &&  )

constexprdefaultnoexcept

operator==()

template<EventTrait T>

constexpr bool helios::ecs::EventIterator< T >::operator== ( const EventIterator< T > &  other ) const

inlineconstexprnoexcept

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/event_reader.hpp.

Definition at line 117 of file event_reader.hpp.

{ return iter_ == other.iter_; }