mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > Class Template Reference

Iterator class for all library maps. More...

#include <Map.h>

Public Member Functions
	AllMapIterator () noexcept=default
	Default constructor.
	AllMapIterator (const AllMapIterator &other) noexcept
	Copy constructor.
	AllMapIterator (AllMapIterator &&other) noexcept
	Deleted move constructor.
	AllMapIterator (const MultiContainerIterator &dataMultiMapIt, const ContainerIterator &dataMapIt, const bool &isMultiMap) noexcept
	Constructor.
AllMapIterator &	operator= (const AllMapIterator &other) noexcept
	Assignment operator.
AllMapIterator &	operator= (AllMapIterator &&other) noexcept
	Deleted move assignment operator.
bool	operator!= (const AllMapIterator &other) const noexcept
	Not equal operator.
bool	operator== (const AllMapIterator &other) const noexcept
	Compare operator.
AllMapIterator &	operator++ () noexcept
	Pre increment operator.
AllMapIterator &	operator-- () noexcept
	Pre decrement operator.
std::pair< KeyType, ValueType >	operator* () const noexcept
	Operator*.
ContainerIterator	GetContainerIterator () const noexcept
	Method for get container iterator.
MultiContainerIterator	GetMultiContainerIterator () const noexcept
	Method for get multi container iterator.
	~AllMapIterator ()=default
	Default destructor.

Detailed Description

template<class MultiContainerIterator, class ContainerIterator, class KeyType, class ValueType>
class mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >

Iterator class for all library maps.

Template Parameters

<MultiContainerIterator>	- The iterator type for the multi container
<ContainerIterator>	- The type of iterator for the container
<KeyType>	- The type of key for the map
<ValueType>	- The type of value for the map

Constructor & Destructor Documentation

AllMapIterator() [1/3]

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::AllMapIterator ( const AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &  other )

inlinenoexcept

Copy constructor.

Parameters

[in]

other

object to copy data from

AllMapIterator() [2/3]

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::AllMapIterator ( AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &&  other )

inlinenoexcept

Deleted move constructor.

Parameters

[in]

other

object to copy data from

AllMapIterator() [3/3]

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::AllMapIterator ( const MultiContainerIterator &  dataMultiMapIt, const ContainerIterator &  dataMapIt, const bool &  isMultiMap  )

inlinenoexcept

Constructor.

Parameters

[in]	dataMultiMapIt	iterator to multi container
[in]	dataMapIt	iterator to container
[in]	isMultiMap	is this Map multi

Member Function Documentation

GetContainerIterator()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

ContainerIterator mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::GetContainerIterator ( ) const

inlinenoexcept

Method for get container iterator.

Returns

stl container iterator

GetMultiContainerIterator()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

MultiContainerIterator mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::GetMultiContainerIterator ( ) const

inlinenoexcept

Method for get multi container iterator.

Returns

stl multi container iterator

operator!=()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

bool mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator!= ( const AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &  other ) const

inlinenoexcept

Not equal operator.

Parameters

[in]

other

object to compare

Returns

true it other and this not equal

operator*()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

std::pair< KeyType, ValueType > mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator* ( ) const

inlinenoexcept

Operator*.

Returns

pair with iterator key and value

operator++()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

AllMapIterator & mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator++ ( )

inlinenoexcept

Pre increment operator.

Returns

incremented iterator

operator--()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

AllMapIterator & mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator-- ( )

inlinenoexcept

Pre decrement operator.

Returns

decremented iterator

operator=() [1/2]

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

AllMapIterator & mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator= ( AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &&  other )

inlinenoexcept

Deleted move assignment operator.

Parameters

[in]

other

object to copy data from

Returns

assigned object

operator=() [2/2]

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

AllMapIterator & mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator= ( const AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &  other )

inlinenoexcept

Assignment operator.

Parameters

[in]

other

object to copy data from

Returns

assigned object

operator==()

template<class MultiContainerIterator , class ContainerIterator , class KeyType , class ValueType >

bool mvlt::AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType >::operator== ( const AllMapIterator< MultiContainerIterator, ContainerIterator, KeyType, ValueType > &  other ) const

inlinenoexcept

Compare operator.

Parameters

[in]

other

object to compare

Returns

true it other and this equal

---

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

• /home/runner/work/MVault/MVault/Source/Map.h