ILList< LListBase, T > Class Template Reference

Template class for intrusive linked lists. More...

Inheritance diagram for ILList< LListBase, T >:

Collaboration diagram for ILList< LListBase, T >:

Public Member Functions
	ILList ()
	Null construct. More...
	ILList (T *a)
	Construct given initial T. More...
	ILList (Istream &)
	Construct from Istream. More...
	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...
	ILList (ILList< LListBase, T > &&)
	Move constructor. More...
template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...
template<class INew >
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...
	~ILList ()
	Destructor. More...
bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...
bool	erase (T *p)
	Remove the specified element from the list and delete it. More...
void	clear ()
	Clear the contents of the list. More...
void	transfer (ILList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...
void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...
void	operator= (ILList< LListBase, T > &&)
	Move assignment operator. More...
Public Member Functions inherited from UILList< LListBase, T >
	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
Istream &	operator>> (Istream &, ILList< LListBase, T > &)
	Read List from Istream, discarding contents of existing List. More...

Additional Inherited Members
Public Types inherited from UILList< LListBase, T >
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

Detailed Description

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

Template class for intrusive linked lists.

Source files

• ILList.H
• ILList.C
• ILListIO.C

Definition at line 50 of file ILList.H.

Constructor & Destructor Documentation

ILList() [1/7]

ILList ( )

inline

Null construct.

Definition at line 80 of file ILList.H.

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

Here is the caller graph for this function:

ILList() [2/7]

ILList ( T *  a )

inline

Construct given initial T.

Definition at line 84 of file ILList.H.

References ILList< LListBase, T >::clear(), ILList< LListBase, T >::erase(), ILList< LListBase, T >::eraseHead(), ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), p, Foam::T(), ILList< LListBase, T >::transfer(), and ILList< LListBase, T >::~ILList().

Here is the call graph for this function:

ILList() [3/7]

ILList

(

Istream &

is

)

Construct from Istream.

Definition at line 138 of file ILListIO.C.

References ILList< LListBase, T >::clear(), Foam::operator>>(), and Foam::blockMeshTools::read().

Here is the call graph for this function:

ILList() [4/7]

ILList

(

const ILList< LListBase, T > &

lst

)

Copy constructor.

Definition at line 31 of file ILList.C.

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

Here is the call graph for this function:

ILList() [5/7]

ILList

(

ILList< LListBase, T > &&

lst

)

Move constructor.

Definition at line 48 of file ILList.C.

References ILList< LListBase, T >::ILList(), and ILList< LListBase, T >::transfer().

Here is the call graph for this function:

ILList() [6/7]

ILList	(	const ILList< LListBase, T > &	lst,
		const CloneArg &	cloneArg
	)

Copy constructor with additional argument for clone.

Definition at line 59 of file ILList.C.

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

Here is the call graph for this function:

ILList() [7/7]

ILList	(	Istream &	is,
		const INew &	iNew
	)

Construct from Istream using given Istream constructor class.

Definition at line 131 of file ILListIO.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

~ILList()

~ILList

(

)

Destructor.

Definition at line 81 of file ILList.C.

References ILList< LListBase, T >::clear().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

eraseHead()

bool eraseHead

(

)

Remove the head element specified from the list and delete it.

Definition at line 90 of file ILList.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

erase()

bool erase

(

T *

p

)

Remove the specified element from the list and delete it.

Definition at line 105 of file ILList.C.

References Foam::T().

Referenced by ILList< LListBase, T >::ILList(), refinementRegions::refinementRegions(), and refinementSurfaces::refinementSurfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

void clear

(

)

Clear the contents of the list.

Definition at line 121 of file ILList.C.

References clear(), and ILList< LListBase, T >::eraseHead().

Referenced by Cloud< passiveParticle >::clear(), DSMCCloud< ParcelType >::clear(), dictionary::clear(), ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), ILList< LListBase, T >::transfer(), and ILList< LListBase, T >::~ILList().

Here is the call graph for this function:

Here is the caller graph for this function:

transfer()

void transfer

(

ILList< LListBase, T > &

lst

)

Transfer the contents of the argument into this List.

and annul the argument list.

Definition at line 134 of file ILList.C.

References ILList< LListBase, T >::clear().

Referenced by ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), and dictionary::transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

void operator=

(

const ILList< LListBase, T > &

lst

)

Assignment operator.

Definition at line 144 of file ILList.C.

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

Referenced by ILList< LListBase, T >::ILList(), and dictionary::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [2/2]

void operator=

(

ILList< LListBase, T > &&

lst

)

Move assignment operator.

Definition at line 161 of file ILList.C.

References ILList< LListBase, T >::transfer().

Here is the call graph for this function:

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  , ILList< LListBase, T > &    )

friend

Read List from Istream, discarding contents of existing List.

---

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

• src/OpenFOAM/containers/LinkedLists/accessTypes/ILList/ILList.H
• src/OpenFOAM/containers/LinkedLists/accessTypes/ILList/ILList.C
• src/OpenFOAM/containers/LinkedLists/accessTypes/ILList/ILListIO.C