sparta::Pipe< DataT >::PipeIterator< is_const_iterator > Class Template Reference

Inheritance diagram for sparta::Pipe< DataT >::PipeIterator< is_const_iterator >:

Collaboration diagram for sparta::Pipe< DataT >::PipeIterator< is_const_iterator >:

Public Member Functions
	PipeIterator (PipePointerType pipe)
	construct.
	PipeIterator (PipePointerType pipe, uint32_t index)
	construct.
	PipeIterator (const PipeIterator &)=default
	Default copy constructor.
	PipeIterator (PipeIterator &&)=default
	Default move constructor.
DataReferenceType	operator* ()
	Override derefrence operator.
DataReferenceType	operator-> ()
	support -> operator
PipeIterator &	operator++ ()
	override Pre-increment operator
PipeIterator	operator++ (int)
	override post-increment operator
bool	operator== (const PipeIterator &it) const
	Equals comparision operator.
bool	operator!= (const PipeIterator &it) const
	Not Equals comparision operator.
bool	isValid () const
	Checks validity of iterator.

Additional Inherited Members
Public Types inherited from sparta::utils::IteratorTraits< std::forward_iterator_tag, value_type >
using	difference_type
using	value_type
using	pointer
using	reference
using	iterator_category

Detailed Description

template<typename DataT>
template<bool is_const_iterator = true>
class sparta::Pipe< DataT >::PipeIterator< is_const_iterator >

Definition at line 79 of file Pipe.hpp.

Constructor & Destructor Documentation

PipeIterator() [1/2]

template<typename DataT >

template<bool is_const_iterator = true>

sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::PipeIterator ( PipePointerType pipe )

inline

construct.

Parameters

pipe	a pointer to the underlaying pipe.

Definition at line 104 of file Pipe.hpp.

PipeIterator() [2/2]

template<typename DataT >

template<bool is_const_iterator = true>

sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::PipeIterator ( PipePointerType pipe, uint32_t index )

inline

construct.

Parameters

pipe	a pointer to the underlaying pipe.
index	index to the pipe container

Definition at line 111 of file Pipe.hpp.

Member Function Documentation

isValid()

template<typename DataT >

template<bool is_const_iterator = true>

bool sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::isValid ( ) const

inline

Checks validity of iterator.

Definition at line 159 of file Pipe.hpp.

operator!=()

template<typename DataT >

template<bool is_const_iterator = true>

bool sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator!= ( const PipeIterator< is_const_iterator > & it ) const

inline

Not Equals comparision operator.

Definition at line 154 of file Pipe.hpp.

Here is the call graph for this function:

operator*()

template<typename DataT >

template<bool is_const_iterator = true>

DataReferenceType sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator* ( )

inline

Override derefrence operator.

Definition at line 120 of file Pipe.hpp.

operator++() [1/2]

template<typename DataT >

template<bool is_const_iterator = true>

PipeIterator & sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator++ ( )

inline

override Pre-increment operator

Definition at line 134 of file Pipe.hpp.

operator++() [2/2]

template<typename DataT >

template<bool is_const_iterator = true>

PipeIterator sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator++ ( int )

inline

override post-increment operator

Definition at line 142 of file Pipe.hpp.

Here is the call graph for this function:

operator->()

template<typename DataT >

template<bool is_const_iterator = true>

DataReferenceType sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator-> ( )

inline

support -> operator

Definition at line 128 of file Pipe.hpp.

Here is the call graph for this function:

operator==()

template<typename DataT >

template<bool is_const_iterator = true>

bool sparta::Pipe< DataT >::PipeIterator< is_const_iterator >::operator== ( const PipeIterator< is_const_iterator > & it ) const

inline

Equals comparision operator.

Definition at line 149 of file Pipe.hpp.

---

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

• /github/workspace/sparta/sparta/resources/Pipe.hpp