Template class for intrusive linked lists. More...

Inheritance diagram for UILList< LListBase, T >:

Collaboration diagram for UILList< LListBase, T >:

Classes
class	const_iterator
	An STL-conforming const_iterator. More...

class	const_reverse_iterator
	An STL-conforming const_reverse_iterator. More...

class	iterator
	An STL-conforming iterator. More...

Public Types
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Public Member Functions
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (UILList< LListBase, T > &&)
	Move assignment operator. More...

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Friends
class	iterator

class	const_iterator

class	const_reverse_iterator

Ostream &	operator (Ostream &, const UILList< LListBase, T > &)

Detailed Description

template<class LListBase, class T>
class Foam::UILList< LListBase, T >

Template class for intrusive linked lists.

Source files

Definition at line 51 of file UILList.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Type of values the DLList contains.

Definition at line 166 of file UILList.H.

◆ reference

typedef T& reference

Type that can be used for storing into DLList::value_type.

objects.

Definition at line 170 of file UILList.H.

◆ const_reference

typedef const T& const_reference

Type that can be used for storing into constant.

DLList::value_type objects.

Definition at line 174 of file UILList.H.

◆ size_type

typedef label size_type

The type that can represent the size of a DLList.

Definition at line 177 of file UILList.H.

◆ LListBase_iterator

typedef LListBase::iterator LListBase_iterator

Definition at line 182 of file UILList.H.

◆ LListBase_const_iterator

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 231 of file UILList.H.

Constructor & Destructor Documentation

◆ UILList() [1/4]

UILList ( )

inline

Null construct.

Definition at line 88 of file UILList.H.

Referenced by UILList< LListBase, T >::UILList().

Here is the caller graph for this function:

◆ UILList() [2/4]

UILList ( T * a )

inline

Construct given initial T.

Definition at line 92 of file UILList.H.

References UILList< LListBase, T >::UILList().

Here is the call graph for this function:

◆ UILList() [3/4]

UILList ( const UILList< LListBase, T > & lst )

Copy constructor.

Definition at line 31 of file UILList.C.

References UILList< LListBase, T >::begin(), and UILList< LListBase, T >::end().

Here is the call graph for this function:

◆ UILList() [4/4]

UILList ( UILList< LListBase, T > && lst )

Move constructor.

Definition at line 41 of file UILList.C.

Member Function Documentation

◆ first() [1/2]

T* first ( )

inline

Return the first entry.

Definition at line 109 of file UILList.H.

References Foam::T().

Referenced by snappyRefineDriver::snappyRefineDriver(), dictionaryEntry::startLineNumber(), dictionary::startLineNumber(), and thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ first() [2/2]

const T* first ( ) const

inline

Return the first entry.

Definition at line 115 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ last() [1/2]

T* last ( )

inline

Return the last entry.

Definition at line 121 of file UILList.H.

References Foam::T().

Referenced by dictionaryEntry::endLineNumber(), dictionary::endLineNumber(), and dictionary::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ last() [2/2]

const T* last ( ) const

inline

Return the last entry.

Definition at line 127 of file UILList.H.

References Foam::T().

Here is the call graph for this function:

◆ removeHead()

T* removeHead ( )

inline

Remove and return head.

Definition at line 136 of file UILList.H.

References Foam::T().

Referenced by ILList< LListBase, T >::eraseHead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove() [1/2]

T* remove ( T * p )

inline

Remove and return element.

Definition at line 142 of file UILList.H.

References p, and Foam::T().

Referenced by dictionary::add(), Cloud< passiveParticle >::move(), and dictionary::remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove() [2/2]

T* remove ( iterator & it )

inline

Remove and return specified by iterator.

Definition at line 148 of file UILList.H.

References UILList< LListBase, T >::operator=(), and Foam::T().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const UILList< LListBase, T > & rhs )

Assignment operator.

Definition at line 50 of file UILList.C.

References UILList< LListBase, T >::begin(), clear(), and UILList< LListBase, T >::end().

Referenced by UILList< LListBase, T >::remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( UILList< LListBase, T > && rhs )

Move assignment operator.

Definition at line 62 of file UILList.C.

◆ begin() [1/2]

iterator begin ( )

inline

Definition at line 218 of file UILList.H.

Referenced by Cloud< passiveParticle >::begin(), ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), UILList< LListBase, T >::operator=(), and UILList< LListBase, T >::UILList().

Here is the caller graph for this function:

◆ end() [1/2]

const iterator& end ( )

inline

Definition at line 223 of file UILList.H.

Referenced by Cloud< passiveParticle >::end(), ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), UILList< LListBase, T >::operator=(), and UILList< LListBase, T >::UILList().

Here is the caller graph for this function:

◆ cbegin()

const_iterator cbegin ( ) const

inline

Definition at line 275 of file UILList.H.

Referenced by Cloud< passiveParticle >::cbegin().

Here is the caller graph for this function:

◆ cend()

const const_iterator& cend ( ) const

inline

Definition at line 280 of file UILList.H.

Referenced by Cloud< passiveParticle >::cend().

Here is the caller graph for this function:

◆ begin() [2/2]

const_iterator begin ( ) const

inline

Definition at line 285 of file UILList.H.

◆ end() [2/2]

const const_iterator& end ( ) const

inline

Definition at line 290 of file UILList.H.

◆ crbegin()

const_reverse_iterator crbegin ( ) const

inline

Definition at line 337 of file UILList.H.

◆ crend()

const const_reverse_iterator& crend ( ) const

inline

Definition at line 342 of file UILList.H.

◆ rbegin()

const_reverse_iterator rbegin ( ) const

inline

Definition at line 349 of file UILList.H.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::readField().

Here is the caller graph for this function:

◆ rend()

const const_reverse_iterator& rend ( ) const

inline

Definition at line 354 of file UILList.H.

References UILList< LListBase, T >::operator!=(), and UILList< LListBase, T >::operator==().

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::readField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const UILList< LListBase, T > & rhs ) const

Equality operation on ULists of the same type.

Returns true when the ULists are element-wise equal (using UList::value_type::operator==). Takes linear time.

Definition at line 70 of file UILList.C.

References Foam::equal().

Referenced by UILList< LListBase, T >::rend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const UILList< LListBase, T > & rhs ) const

The opposite of the equality operation. Takes linear time.

Definition at line 95 of file UILList.C.

References Foam::operator==().

Referenced by UILList< LListBase, T >::rend().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ iterator

friend class iterator

friend

Definition at line 75 of file UILList.H.

◆ const_iterator

friend class const_iterator

friend

Definition at line 78 of file UILList.H.

◆ const_reverse_iterator

friend class const_reverse_iterator

friend

Definition at line 81 of file UILList.H.

◆ operator

Ostream& operator	(	Ostream &	,
		const UILList< LListBase, T > &
	)

friend

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

src/OpenFOAM/containers/LinkedLists/accessTypes/UILList/UILList.H
src/OpenFOAM/containers/LinkedLists/accessTypes/UILList/UILList.C

Classes

Public Types

Public Member Functions

Friends

Detailed Description

template<class LListBase, class T> class Foam::UILList< LListBase, T >

Member Typedef Documentation

◆ value_type

◆ reference

◆ const_reference

◆ size_type

◆ LListBase_iterator

◆ LListBase_const_iterator

Constructor & Destructor Documentation

◆ UILList() [1/4]

◆ UILList() [2/4]

◆ UILList() [3/4]

◆ UILList() [4/4]

Member Function Documentation

◆ first() [1/2]

◆ first() [2/2]

◆ last() [1/2]

◆ last() [2/2]

◆ removeHead()

◆ remove() [1/2]

◆ remove() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ begin() [1/2]

◆ end() [1/2]

◆ cbegin()

◆ cend()

◆ begin() [2/2]

◆ end() [2/2]

◆ crbegin()

◆ crend()

◆ rbegin()

◆ rend()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ iterator

◆ const_iterator

◆ const_reverse_iterator

◆ operator

template<class LListBase, class T>
class Foam::UILList< LListBase, T >