UPtrList< T >::iterator Class Reference

Forward iterator with non-const access. More...

#include <UPtrList.H>

Inheritance diagram for UPtrList< T >::iterator:

Collaboration diagram for UPtrList< T >::iterator:

Public Types
using	pointer = T*
using	reference = T&
Public Types inherited from UPtrList< T >::Iterator< false >
using	list_type
	The list container type.

Public Member Functions
constexpr	iterator () noexcept=default
	Default construct - an end iterator.
	iterator (const Iterator< false > &iter)
	Copy construct from similar access type.
pointer	get () const
	Pointer to the referenced object (failsafe).
reference	val () const
	Reference to the object.
pointer	operator-> () const
	Pointer to the referenced object.
reference	operator* () const
	Reference to the object.
reference	operator() () const
	Legacy call operator: reference to the object.
iterator &	operator++ ()
	Move to the next non-nullptr entry.
iterator	operator++ (int)
Public Member Functions inherited from UPtrList< T >::Iterator< false >
bool	good () const noexcept
	True if iterator points to a non-null entry.
label	key () const noexcept
	The iterator position/index within the list.
bool	operator== (const Iterator< Any > &iter) const noexcept
	Compare hash-entry element pointers.
bool	operator!= (const Iterator< Any > &iter) const noexcept

Additional Inherited Members
Protected Member Functions inherited from UPtrList< T >::Iterator< false >
constexpr	Iterator () noexcept
	Default construct. Also the same as the end iterator.
void	increment ()
	Increment to the next non-null position.
	operator const Iterator< Any > & () const
	Permit explicit cast to the other (const/non-const) iterator.
Protected Attributes inherited from UPtrList< T >::Iterator< false >
list_type *	list_
	The parent being iterated.
label	pos_
	The position within the list.

Detailed Description

template<class T>
class Foam::UPtrList< T >::iterator

Forward iterator with non-const access.

Definition at line 650 of file UPtrList.H.

Member Typedef Documentation

pointer

template<class T>

using pointer = T*

Definition at line 655 of file UPtrList.H.

reference

template<class T>

using reference = T&

Definition at line 656 of file UPtrList.H.

Constructor & Destructor Documentation

iterator() [1/2]

template<class T>

iterator ( )

constexprdefaultnoexcept

Default construct - an end iterator.

References Foam::noexcept.

Referenced by iterator(), and operator++().

Here is the caller graph for this function:

iterator() [2/2]

template<class T>

iterator ( const Iterator< false > & iter )

inlineexplicit

Copy construct from similar access type.

Definition at line 669 of file UPtrList.H.

References UPtrList< T >::Iterator< false >::Iterator(), and iterator().

Here is the call graph for this function:

Member Function Documentation

get()

template<class T>

T * get ( ) const

inline

Pointer to the referenced object (failsafe).

Definition at line 345 of file UPtrListI.H.

References UPtrList< T >::Iterator< false >::good(), UPtrList< T >::Iterator< false >::list_, UPtrList< T >::Iterator< false >::pos_, and Foam::T().

Referenced by operator->().

Here is the call graph for this function:

Here is the caller graph for this function:

val()

template<class T>

T & val ( ) const

inline

Reference to the object.

Definition at line 352 of file UPtrListI.H.

References UPtrList< T >::Iterator< false >::list_, UPtrList< T >::Iterator< false >::pos_, and Foam::T().

Referenced by operator()(), and operator*().

Here is the call graph for this function:

Here is the caller graph for this function:

operator->()

template<class T>

pointer operator-> ( ) const

inline

Pointer to the referenced object.

Definition at line 690 of file UPtrList.H.

References get().

Here is the call graph for this function:

operator*()

template<class T>

reference operator* ( ) const

inline

Reference to the object.

Definition at line 695 of file UPtrList.H.

References val().

Here is the call graph for this function:

operator()()

template<class T>

reference operator() ( ) const

inline

Legacy call operator: reference to the object.

Definition at line 700 of file UPtrList.H.

References val().

Here is the call graph for this function:

operator++() [1/2]

template<class T>

Foam::UPtrList< T >::iterator & operator++ ( )

inline

Move to the next non-nullptr entry.

Definition at line 360 of file UPtrListI.H.

References UPtrList< T >::Iterator< false >::increment().

Here is the call graph for this function:

operator++() [2/2]

template<class T>

Foam::UPtrList< T >::iterator operator++ ( int )

inline

Definition at line 369 of file UPtrListI.H.

References UPtrList< T >::Iterator< false >::increment(), and iterator().

Here is the call graph for this function:

---

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

• src/OpenFOAM/containers/PtrLists/UPtrList/UPtrList.H
• src/OpenFOAM/containers/PtrLists/UPtrList/UPtrListI.H