Iterator for registered arrays. More...

#include <ogdf/basic/RegisteredArray.h>

Public Types
using	array_pointer_type = typename std::conditional< isConst, const ArrayType , ArrayType >::type

using	key_type = typename ArrayType::key_type

using	registry_type = typename ArrayType::registry_type

using	value_type = typename std::conditional< isConst, const typename ArrayType::value_type, typename ArrayType::value_type >::type

Public Member Functions
	RegisteredArrayIterator ()
	Creates a new iterator associated with no array.

	RegisteredArrayIterator (KeyIterator mIt, array_pointer_type mArray)
	Creates a new iterator.

key_type	key () const
	Returns the current key.

bool	operator!= (const RegisteredArrayIterator< ArrayType, KeyIterator, isConst > &iter) const
	Inequality operator.

value_type &	operator* () const
	Returns the value of key() in the registered array.

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > &	operator++ ()
	Increment operator (prefix).

RegisteredArrayIterator< ArrayType, KeyIterator, isConst >	operator++ (int)
	Increment operator (postfix).

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > &	operator-- ()
	Decrement operator (prefix).

RegisteredArrayIterator< ArrayType, KeyIterator, isConst >	operator-- (int)
	Decrement operator (postfix).

bool	operator== (const RegisteredArrayIterator< ArrayType, KeyIterator, isConst > &iter) const
	Equality operator.

value_type &	value () const
	Returns the value of key() in the registered array.

Private Attributes
array_pointer_type	m_array

KeyIterator	m_it

Detailed Description

template<class ArrayType, class KeyIterator, bool isConst = false>
class ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >

Iterator for registered arrays.

Provides an iterator for the key-value pairs stored in registered arrays.

Template Parameters

ArrayType	The type of registered array.
KeyIterator	An iterator for the keys in the registry. Determines the order of the key-value pairs.
isConst	Whether the iterator allows modifying the data or not.

Definition at line 404 of file RegisteredArray.h.

Member Typedef Documentation

◆ array_pointer_type

template<class ArrayType , class KeyIterator , bool isConst = false>

using ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::array_pointer_type = typename std::conditional<isConst, const ArrayType*, ArrayType*>::type

Definition at line 410 of file RegisteredArray.h.

◆ key_type

template<class ArrayType , class KeyIterator , bool isConst = false>

using ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::key_type = typename ArrayType::key_type

Definition at line 407 of file RegisteredArray.h.

◆ registry_type

template<class ArrayType , class KeyIterator , bool isConst = false>

using ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::registry_type = typename ArrayType::registry_type

Definition at line 406 of file RegisteredArray.h.

◆ value_type

template<class ArrayType , class KeyIterator , bool isConst = false>

using ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::value_type = typename std::conditional<isConst, const typename ArrayType::value_type, typename ArrayType::value_type>::type

Definition at line 408 of file RegisteredArray.h.

Constructor & Destructor Documentation

◆ RegisteredArrayIterator() [1/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::RegisteredArrayIterator ( )

inline

Creates a new iterator associated with no array.

Definition at line 418 of file RegisteredArray.h.

◆ RegisteredArrayIterator() [2/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::RegisteredArrayIterator	(	KeyIterator	mIt,
		array_pointer_type	mArray
	)

inline

Creates a new iterator.

Parameters

mIt	An iterator pointing to the current key.
mArray	A pointer to the registered array containing the desired values.

Definition at line 425 of file RegisteredArray.h.

Member Function Documentation

◆ key()

template<class ArrayType , class KeyIterator , bool isConst = false>

key_type ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::key ( ) const

inline

Returns the current key.

Definition at line 429 of file RegisteredArray.h.

◆ operator!=()

template<class ArrayType , class KeyIterator , bool isConst = false>

bool ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator!= ( const RegisteredArrayIterator< ArrayType, KeyIterator, isConst > & iter ) const

inline

Inequality operator.

Definition at line 443 of file RegisteredArray.h.

◆ operator*()

template<class ArrayType , class KeyIterator , bool isConst = false>

value_type & ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator* ( ) const

inline

Returns the value of key() in the registered array.

Definition at line 435 of file RegisteredArray.h.

◆ operator++() [1/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > & ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator++ ( )

inline

Increment operator (prefix).

Definition at line 448 of file RegisteredArray.h.

◆ operator++() [2/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator++ ( int )

inline

Increment operator (postfix).

Definition at line 454 of file RegisteredArray.h.

◆ operator--() [1/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > & ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator-- ( )

inline

Decrement operator (prefix).

Definition at line 461 of file RegisteredArray.h.

◆ operator--() [2/2]

template<class ArrayType , class KeyIterator , bool isConst = false>

RegisteredArrayIterator< ArrayType, KeyIterator, isConst > ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator-- ( int )

inline

Decrement operator (postfix).

Definition at line 467 of file RegisteredArray.h.

◆ operator==()

template<class ArrayType , class KeyIterator , bool isConst = false>

bool ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::operator== ( const RegisteredArrayIterator< ArrayType, KeyIterator, isConst > & iter ) const

inline

Equality operator.

Definition at line 438 of file RegisteredArray.h.

◆ value()

template<class ArrayType , class KeyIterator , bool isConst = false>

value_type & ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::value ( ) const

inline

Returns the value of key() in the registered array.

Definition at line 432 of file RegisteredArray.h.

Member Data Documentation

◆ m_array

template<class ArrayType , class KeyIterator , bool isConst = false>

array_pointer_type ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::m_array

private

Definition at line 414 of file RegisteredArray.h.

◆ m_it

template<class ArrayType , class KeyIterator , bool isConst = false>

KeyIterator ogdf::RegisteredArrayIterator< ArrayType, KeyIterator, isConst >::m_it

private

Definition at line 413 of file RegisteredArray.h.

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

include/ogdf/basic/RegisteredArray.h

OpenGraph DrawingFramework

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ array_pointer_type

◆ key_type

◆ registry_type

◆ value_type

Constructor & Destructor Documentation

◆ RegisteredArrayIterator() [1/2]

◆ RegisteredArrayIterator() [2/2]

Member Function Documentation

◆ key()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator==()

◆ value()

Member Data Documentation

◆ m_array

◆ m_it

Open
Graph Drawing
Framework