DLListBase::const_iterator Class Reference

A primitive const node iterator (bidirectional). More...

#include <DLListBase.H>

Public Member Functions
	const_iterator (const const_iterator &)=default
	Copy construct.
	const_iterator (const DLListBase *list, const link *item)
	Construct for a node on a list.
	const_iterator (const DLListBase::iterator &iter)
	Copy construct from a non-const iterator.
const link *	get_node () const noexcept
	The storage node.
bool	good () const noexcept
	Pointing at a valid storage node.
void	prev ()
	Move backward through list.
void	next ()
	Move forward through list.
const_iterator &	operator= (const const_iterator &)=default
	Copy assignment.
bool	operator== (const const_iterator &) const
bool	operator!= (const const_iterator &) const

Detailed Description

A primitive const node iterator (bidirectional).

Must normally be extended by inheriting classes. Since this iterator works bidirectionally, it can be used as the basis for a derived const_reverse_iterator

Definition at line 357 of file DLListBase.H.

Constructor & Destructor Documentation

const_iterator() [1/3]

const_iterator ( const const_iterator & )

default

Copy construct.

References const_iterator(), DLListBase::DLListBase(), good(), next(), Foam::noexcept, and prev().

Referenced by const_iterator(), operator!=(), operator=(), and operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

const_iterator() [2/3]

const_iterator ( const DLListBase * list, const link * item )

inline

Construct for a node on a list.

Definition at line 308 of file DLListBaseI.H.

References DLListBase::DLListBase().

Here is the call graph for this function:

const_iterator() [3/3]

const_iterator ( const DLListBase::iterator & iter )

inline

Copy construct from a non-const iterator.

Definition at line 319 of file DLListBaseI.H.

Member Function Documentation

get_node()

const Foam::DLListBase::link * get_node ( ) const

inlinenoexcept

The storage node.

Definition at line 330 of file DLListBaseI.H.

References Foam::noexcept.

good()

bool good ( ) const

inlinenoexcept

Pointing at a valid storage node.

Definition at line 336 of file DLListBaseI.H.

References Foam::noexcept.

Referenced by const_iterator().

Here is the caller graph for this function:

prev()

void prev ( )

inline

Move backward through list.

Definition at line 342 of file DLListBaseI.H.

Referenced by const_iterator().

Here is the caller graph for this function:

next()

void next ( )

inline

Move forward through list.

Definition at line 358 of file DLListBaseI.H.

Referenced by const_iterator().

Here is the caller graph for this function:

operator=()

const_iterator & operator= ( const const_iterator & )

default

Copy assignment.

References DLListBase::begin(), DLListBase::cbegin(), DLListBase::cend(), const_iterator(), DLListBase::crbegin(), DLListBase::crend(), and DLListBase::end().

Here is the call graph for this function:

operator==()

bool operator== ( const const_iterator & iter ) const

inline

Definition at line 374 of file DLListBaseI.H.

References const_iterator().

Here is the call graph for this function:

operator!=()

bool operator!= ( const const_iterator & iter ) const

inline

Definition at line 383 of file DLListBaseI.H.

References const_iterator().

Here is the call graph for this function:

---

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

• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H
• src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBaseI.H