exml::iterator< EXML_BASE_T, EXML_RETURN_T > Class Template Reference
#include <iterator.hpp>
Public Member Functions | |
| iterator (EXML_BASE_T &_obj, size_t _pos) | |
| iterator (const EXML_BASE_T &_obj, size_t _pos) | |
| iterator (const iterator &_obj) | |
| iterator & | operator= (const iterator &_obj) |
| iterator & | operator+= (int32_t _val) |
| iterator | operator+ (int32_t _val) const |
| iterator & | operator-= (int32_t _val) |
| iterator | operator- (int32_t _val) const |
| iterator & | operator++ () |
| iterator | operator++ (int) |
| iterator & | operator-- () |
| iterator | operator-- (int) |
| bool | operator== (const iterator &_obj) const |
| bool | operator!= (const iterator &_obj) const |
| const EXML_RETURN_T | operator* () const noexcept |
| EXML_RETURN_T | operator* () noexcept |
Detailed Description
template<class EXML_BASE_T, class EXML_RETURN_T>
class exml::iterator< EXML_BASE_T, EXML_RETURN_T >
iterator on elements.
Constructor & Destructor Documentation
§ iterator() [1/3]
template<class EXML_BASE_T , class EXML_RETURN_T >
| exml::iterator< EXML_BASE_T, EXML_RETURN_T >::iterator | ( | EXML_BASE_T & | _obj, |
| size_t | _pos | ||
| ) |
Constructor of the generic object class.
- Parameters
-
[in] _obj Reference on the object to go threw [in] _pos Position in the object
§ iterator() [2/3]
template<class EXML_BASE_T , class EXML_RETURN_T >
| exml::iterator< EXML_BASE_T, EXML_RETURN_T >::iterator | ( | const EXML_BASE_T & | _obj, |
| size_t | _pos | ||
| ) |
Const constructor of the generic const object class.
- Parameters
-
[in] _obj Reference on the object to go threw [in] _pos Position in the object
§ iterator() [3/3]
template<class EXML_BASE_T , class EXML_RETURN_T >
| exml::iterator< EXML_BASE_T, EXML_RETURN_T >::iterator | ( | const iterator< EXML_BASE_T, EXML_RETURN_T > & | _obj | ) |
Copy iterator.
- Parameters
-
[in] _obj Iterator to copy
Member Function Documentation
§ operator!=()
template<class EXML_BASE_T , class EXML_RETURN_T >
| bool exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator!= | ( | const iterator< EXML_BASE_T, EXML_RETURN_T > & | _obj | ) | const |
In-Equality compare operator with an other iterator.
- Parameters
-
[in] _obj Reference on the comparing iterator
- Returns
- true The iterators are NOT identical
- false The iterators are identical
§ operator*() [1/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
|
noexcept |
Get the property Value.
- Returns
- Const reference on the value.
§ operator*() [2/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
|
noexcept |
Get the property Value.
- Returns
- Const reference on the value.
§ operator+()
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator+ | ( | int32_t | _val | ) | const |
Operator+ Addition a value.
- Parameters
-
[in] _val Value to addition
- Returns
- New iterator containing the value
§ operator++() [1/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator& exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator++ | ( | ) |
Operator++ Pre-incrementation of this iterator.
- Returns
- Local reference of the iterator incremented
§ operator++() [2/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator++ | ( | int | ) |
Operator++ Post-incrementation of this iterator.
- Returns
- New iterator containing the last value
§ operator+=()
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator& exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator+= | ( | int32_t | _val | ) |
Operator+= Addition value.
- Parameters
-
[in] _val Value to addition
- Returns
- Local reference of the iterator additionned
§ operator-()
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator- | ( | int32_t | _val | ) | const |
Operator- Decrement a value.
- Parameters
-
[in] _val Value to addition
- Returns
- New iterator containing the value
§ operator--() [1/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator& exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator-- | ( | ) |
Operator++ Pre-decrementation of this iterator.
- Returns
- Local reference of the iterator incremented
§ operator--() [2/2]
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator-- | ( | int | ) |
Operator++ Post-decrementation of this iterator.
- Returns
- New iterator containing the last value
§ operator-=()
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator& exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator-= | ( | int32_t | _val | ) |
Operator-= Decrement a value.
- Parameters
-
[in] _val Value to addition
- Returns
- Local reference of the iterator decremented
§ operator=()
template<class EXML_BASE_T , class EXML_RETURN_T >
| iterator& exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator= | ( | const iterator< EXML_BASE_T, EXML_RETURN_T > & | _obj | ) |
Operator= Asignement iterator.
- Parameters
-
[in] _obj Iterator to copy
- Returns
- Local reference of the iterator assigned
§ operator==()
template<class EXML_BASE_T , class EXML_RETURN_T >
| bool exml::iterator< EXML_BASE_T, EXML_RETURN_T >::operator== | ( | const iterator< EXML_BASE_T, EXML_RETURN_T > & | _obj | ) | const |
Equality compare operator with an other iterator.
- Parameters
-
[in] _obj Reference on the comparing iterator
- Returns
- true The iterators are identical
- false The iterators are NOT identical
The documentation for this class was generated from the following file:
- framework/atria-soft/exml/exml/iterator.hpp
