FreeFOAM The Cross-Platform CFD Toolkit
ILList< LListBase, T > Class Template Reference

Template class for intrusive linked lists. More...

#include <OpenFOAM/ILList.H>


Detailed Description

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

Template class for intrusive linked lists.

Source files

Definition at line 65 of file ILList.H.

+ Inheritance diagram for ILList< LListBase, T >:
+ Collaboration diagram for ILList< LListBase, T >:

List of all members.

Public Member Functions

 ILList ()
 Null construct.
 ILList (T *a)
 Construct given initial T.
 ILList (Istream &)
 Construct from Istream.
 ILList (const ILList< LListBase, T > &)
 Construct as copy.
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
template<class INew >
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 ~ILList ()
bool eraseHead ()
 Remove the head element specified from the list and delete it.
bool erase (T *p)
 Remove the specified element from the list and delete it.
void clear ()
 Clear the contents of the list.
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List.
void operator= (const ILList< LListBase, T > &)
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct.
 UILList (T *a)
 Construct given initial T.
 UILList (const UILList< LListBase, T > &)
 Construct as copy.
T * first ()
 Return the first entry.
const T * first () const
 Return the first entry.
T * last ()
 Return the last entry.
const T * last () const
 Return the last entry.
T * removeHead ()
 Remove and return head.
T * remove (T *p)
 Remove and return element.
T * remove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< LListBase, T > &)
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time.

Friends

Istream & operator>> (Istream &, ILList< LListBase, T > &)
 Read List from Istream, discarding contents of existing List.

Additional Inherited Members

- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains.
typedef T & reference
 Type that can be used for storing into DLList::value_type.
typedef const T & const_reference
 Type that can be used for storing into constant.
typedef label size_type
 The type that can represent the size of a DLList.
typedef LListBase::iterator LListBase_iterator
typedef LListBase::const_iterator LListBase_const_iterator

Constructor & Destructor Documentation

ILList ( )
inline

Null construct.

Definition at line 81 of file ILList.H.

ILList ( T *  a)
inline

Construct given initial T.

Definition at line 85 of file ILList.H.

ILList ( Istream &  is)

Construct from Istream.

Definition at line 141 of file ILListIO.C.

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

Construct as copy.

Definition at line 31 of file ILList.C.

References append().

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

Copy constructor with additional argument for clone.

Definition at line 51 of file ILList.C.

References append().

ILList ( Istream &  is,
const INew &  iNew 
)

Construct from Istream using given Istream constructor class.

Definition at line 134 of file ILListIO.C.

~ILList ( )

Definition at line 74 of file ILList.C.

References clear().


Member Function Documentation

bool eraseHead ( )

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

Definition at line 83 of file ILList.C.

References Foam::T().

bool erase ( T *  p)

Remove the specified element from the list and delete it.

Definition at line 98 of file ILList.C.

References Foam::T().

void transfer ( ILList< LListBase, T > &  lst)

Transfer the contents of the argument into this List.

and annull the argument list.

Definition at line 127 of file ILList.C.

References clear().

void operator= ( const ILList< LListBase, T > &  lst)

Definition at line 137 of file ILList.C.

References append(), and clear().


Friends And Related Function Documentation

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: