Dev Essential  1.6.3
Loading...
Searching...
No Matches
ddl::codec::ElementIteratorConst< ElementAccessType > Class Template Reference

The const element iterator. More...

#include <codec_iterator.h>

Public Types

using element_type = typename ElementAccessType::element_type
 The element type in use.
 
using value_type = const element_type
 const value type of the iterator
 
using const_reference = value_type&
 const reference value type
 
using const_pointer = value_type*
 pointer to const data value type
 
using difference_type = int
 difference value type
 
using iterator_category = std::forward_iterator_tag
 iterator type
 

Public Member Functions

 ElementIteratorConst ()=delete
 default CTOR
 
 ElementIteratorConst (value_type &&element)
 CTOR for one element.
 
ElementIteratorConstoperator++ ()
 increasing operator to the next position.
 
ElementIteratorConst operator++ (int)
 iterator increasing.
 
bool operator== (const ElementIteratorConst &rhs) const
 checks for equality (refering the same element!)
 
bool operator!= (const ElementIteratorConst &rhs) const
 checks for not equality (does not refer the same element!)
 
const_reference operator* () const
 defering access (check for end!)
 
const_pointer operator-> () const
 pointer access (check for end!)
 

Detailed Description

template<typename ElementAccessType>
class ddl::codec::ElementIteratorConst< ElementAccessType >

The const element iterator.

See also
ChildElements.
Template Parameters
ElementAccessTypeThe element access concept type. (see concept templates FactoryElementAccess, DecoderElementAccess, CodecElementAccess)

Constructor & Destructor Documentation

◆ ElementIteratorConst()

template<typename ElementAccessType>
ddl::codec::ElementIteratorConst< ElementAccessType >::ElementIteratorConst ( value_type && element)
inline

CTOR for one element.

Parameters
elementthe element.

Member Function Documentation

◆ operator!=()

template<typename ElementAccessType>
bool ddl::codec::ElementIteratorConst< ElementAccessType >::operator!= ( const ElementIteratorConst< ElementAccessType > & rhs) const
inline

checks for not equality (does not refer the same element!)

Parameters
rhsthe other iterator
Returns
true is not equal
false is equal

◆ operator*()

template<typename ElementAccessType>
const_reference ddl::codec::ElementIteratorConst< ElementAccessType >::operator* ( ) const
inline

defering access (check for end!)

Returns
const reference

◆ operator++() [1/2]

template<typename ElementAccessType>
ElementIteratorConst & ddl::codec::ElementIteratorConst< ElementAccessType >::operator++ ( )
inline

increasing operator to the next position.

Returns
self_type

◆ operator++() [2/2]

template<typename ElementAccessType>
ElementIteratorConst ddl::codec::ElementIteratorConst< ElementAccessType >::operator++ ( int )
inline

iterator increasing.

Returns
self_type

◆ operator->()

template<typename ElementAccessType>
const_pointer ddl::codec::ElementIteratorConst< ElementAccessType >::operator-> ( ) const
inline

pointer access (check for end!)

Returns
const pointer

◆ operator==()

template<typename ElementAccessType>
bool ddl::codec::ElementIteratorConst< ElementAccessType >::operator== ( const ElementIteratorConst< ElementAccessType > & rhs) const
inline

checks for equality (refering the same element!)

Parameters
rhsthe other iterator
Returns
true is equal
false is not equal

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