Public Member Functions | List of all members
DLListBase::const_iterator Class Reference

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

Public Member Functions

 const_iterator (const const_iterator &)=default
 Copy construct. More...
 
 const_iterator (const DLListBase *list, const link *item)
 Construct for a node on a list. More...
 
 const_iterator (const DLListBase::iterator &iter)
 Copy construct from a non-const iterator. More...
 
const link * get_node () const
 The storage node. More...
 
bool good () const
 Pointing at a valid storage node. More...
 
bool found () const
 Deprecated(2019-01) Pointing at a valid storage node. More...
 
void prev ()
 Move backward through list. More...
 
void next ()
 Move forward through list. More...
 
const_iterator & operator= (const const_iterator &)=default
 Copy assignment. More...
 
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 270 of file DLListBase.H.

Constructor & Destructor Documentation

◆ const_iterator() [1/3]

const_iterator ( const const_iterator &  )
default

Copy construct.

◆ const_iterator() [2/3]

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

Construct for a node on a list.

Definition at line 340 of file DLListBaseI.H.

◆ const_iterator() [3/3]

const_iterator ( const DLListBase::iterator &  iter)
inline

Copy construct from a non-const iterator.

Definition at line 351 of file DLListBaseI.H.

Member Function Documentation

◆ get_node()

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

The storage node.

Definition at line 361 of file DLListBaseI.H.

◆ good()

bool good ( ) const
inline

Pointing at a valid storage node.

Definition at line 367 of file DLListBaseI.H.

Referenced by DLListBase::const_iterator::found().

Here is the caller graph for this function:

◆ found()

bool found ( ) const
inline

Deprecated(2019-01) Pointing at a valid storage node.

Deprecated:
(2019-01) - use good() method

Definition at line 300 of file DLListBase.H.

References DLListBase::const_iterator::good().

Here is the call graph for this function:

◆ prev()

void prev ( )
inline

Move backward through list.

Definition at line 373 of file DLListBaseI.H.

◆ next()

void next ( )
inline

Move forward through list.

Definition at line 389 of file DLListBaseI.H.

◆ operator=()

const_iterator& operator= ( const const_iterator &  )
default

Copy assignment.

◆ operator==()

bool operator== ( const const_iterator &  iter) const
inline

Definition at line 406 of file DLListBaseI.H.

◆ operator!=()

bool operator!= ( const const_iterator &  iter) const
inline

Definition at line 415 of file DLListBaseI.H.

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