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

Template class for intrusive linked lists. More...

#include <OpenFOAM/UILList.H>


Detailed Description

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

Template class for intrusive linked lists.

Source files

Definition at line 67 of file UILList.H.

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

List of all members.

Classes

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

Public Types

typedef T value_type
 Type of values the DLList contains.
typedef Treference
 Type that can be used for storing into DLList::value_type.
typedef const Tconst_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

Public Member Functions

 UILList ()
 Null construct.
 UILList (T *a)
 Construct given initial T.
 UILList (const UILList< LListBase, T > &)
 Construct as copy.
Tfirst ()
 Return the first entry.
const Tfirst () const
 Return the first entry.
Tlast ()
 Return the last entry.
const Tlast () const
 Return the last entry.
TremoveHead ()
 Remove and return head.
Tremove (T *p)
 Remove and return element.
Tremove (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

class iterator
class const_iterator
Ostreamoperator (Ostream &, const UILList< LListBase, T > &)

Member Typedef Documentation

typedef T value_type

Type of values the DLList contains.

Definition at line 157 of file UILList.H.

typedef T& reference

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

objects.

Definition at line 161 of file UILList.H.

typedef const T& const_reference

Type that can be used for storing into constant.

DLList::value_type objects.

Definition at line 165 of file UILList.H.

typedef label size_type

The type that can represent the size of a DLList.

Definition at line 168 of file UILList.H.

typedef LListBase::iterator LListBase_iterator

Definition at line 173 of file UILList.H.

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 215 of file UILList.H.


Constructor & Destructor Documentation

UILList ( )
inline

Null construct.

Definition at line 86 of file UILList.H.

UILList ( T a)
inline

Construct given initial T.

Definition at line 90 of file UILList.H.

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

Construct as copy.

Definition at line 33 of file UILList.C.

References append().


Member Function Documentation

T* first ( )
inline

Return the first entry.

Definition at line 104 of file UILList.H.

Referenced by UILList< DLListBase, ParcelType >::first().

const T* first ( ) const
inline

Return the first entry.

Definition at line 110 of file UILList.H.

T* last ( )
inline

Return the last entry.

Definition at line 116 of file UILList.H.

Referenced by UILList< DLListBase, ParcelType >::last().

const T* last ( ) const
inline

Return the last entry.

Definition at line 122 of file UILList.H.

T* removeHead ( )
inline

Remove and return head.

Definition at line 131 of file UILList.H.

Referenced by UILList< DLListBase, ParcelType >::removeHead().

T* remove ( T p)
inline

Remove and return element.

Definition at line 137 of file UILList.H.

Referenced by UILList< DLListBase, ParcelType >::remove().

T* remove ( iterator it)
inline

Remove and return specified by iterator.

Definition at line 143 of file UILList.H.

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

Definition at line 45 of file UILList.C.

References append(), and clear().

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 58 of file UILList.C.

References equal().

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

The opposite of the equality operation. Takes linear time.

Definition at line 84 of file UILList.C.

References Foam::operator==().


Friends And Related Function Documentation

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

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