OpenFOAM logo
Open Source CFD Toolkit

DLListBase Class Reference

Inheritance diagram for DLListBase:

Inheritance graph
[legend]
Collaboration diagram for DLListBase:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label size () const
 Return number of elements in list.
linkfirst ()
 Return first entry.
const linkfirst () const
 Return const access to first entry.
linklast ()
 Return last entry.
const linklast () const
 Return const access to last entry.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
linkremoveHead ()
 Remove and return head.
linkremove (link *)
 Remove and return element.
void clear ()
 Clear the list.
iterator begin ()
const iteratorend ()
const_iterator begin () const
const const_iteratorend () const

Static Public Attributes

iterator endIter
 iterator returned by end()
const_iterator endConstIter
 const_iterator returned by end()

Friends

class iterator
class const_iterator

Constructor & Destructor Documentation

DLListBase  )  [inline]
 

Null construct.

Definition at line 64 of file DLListBaseI.H.

References DLListBase::link::next_, and DLListBase::link::prev_.

DLListBase link  )  [inline]
 

Construct given initial entry.

Definition at line 73 of file DLListBaseI.H.

~DLListBase  )  [inline]
 

Definition at line 86 of file DLListBaseI.H.


Member Function Documentation

void append link  ) 
 

Add at tail of list.

DLListBase::const_iterator begin  )  const [inline]
 

Definition at line 309 of file DLListBaseI.H.

DLListBase::iterator begin  )  [inline]
 

Definition at line 217 of file DLListBaseI.H.

void clear  )  [inline]
 

Clear the list.

Reimplemented in DictionaryBase< UIDLList< T >, T >, DictionaryBase< IDLList< T >, T >, DictionaryBase< DLList< T * >, T >, DictionaryBase< DLPtrList< T >, T >, ILList< DLListBase, passiveParticle >, ILList< DLListBase, indexedParticle >, ILList< DLListBase, T >, ILList< DLListBase, particleType >, ILList< DLListBase, parcel >, ILList< DLListBase, entry >, LList< DLListBase, T >, LList< DLListBase, T * >, and LPtrList< DLListBase, T >.

Definition at line 152 of file DLListBaseI.H.

const DLListBase::const_iterator & end  )  const [inline]
 

Definition at line 322 of file DLListBaseI.H.

const DLListBase::iterator & end  )  [inline]
 

Reimplemented in JobInfo.

Definition at line 230 of file DLListBaseI.H.

const DLListBase::link * first  )  const [inline]
 

Return const access to first entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, and UILList< DLListBase, entry >.

Definition at line 113 of file DLListBaseI.H.

DLListBase::link * first  )  [inline]
 

Return first entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, and UILList< DLListBase, entry >.

Definition at line 100 of file DLListBaseI.H.

Referenced by DLListBase::const_iterator::operator++(), and DLListBase::iterator::operator++().

void insert link  ) 
 

Add at head of list.

const DLListBase::link * last  )  const [inline]
 

Return const access to last entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, and UILList< DLListBase, entry >.

Definition at line 139 of file DLListBaseI.H.

DLListBase::link * last  )  [inline]
 

Return last entry.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, and UILList< DLListBase, entry >.

Definition at line 126 of file DLListBaseI.H.

link* remove link  ) 
 

Remove and return element.

link* removeHead  ) 
 

Remove and return head.

Reimplemented in LList< DLListBase, T >, LList< DLListBase, T * >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, and UILList< DLListBase, entry >.

label size  )  const [inline]
 

Return number of elements in list.

Definition at line 93 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Referenced by DLListBase::const_iterator::operator++(), and DLListBase::iterator::operator++().

Here is the call graph for this function:

bool swapDown link  ) 
 

Swap this element with the one below unless it is at the bottom.

bool swapUp link  ) 
 

Swap this element with the one above unless it is at the top.


Friends And Related Function Documentation

friend class const_iterator [friend]
 

Reimplemented in Cloud, LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, Cloud< indexedParticle >, Cloud< parcel >, and Cloud< passiveParticle >.

Definition at line 104 of file DLListBase.H.

friend class iterator [friend]
 

Reimplemented in Cloud, LList< DLListBase, T >, LList< DLListBase, T * >, LPtrList< DLListBase, T >, UILList< DLListBase, passiveParticle >, UILList< DLListBase, indexedParticle >, UILList< DLListBase, T >, UILList< DLListBase, particleType >, UILList< DLListBase, parcel >, UILList< DLListBase, entry >, Cloud< indexedParticle >, Cloud< parcel >, and Cloud< passiveParticle >.

Definition at line 101 of file DLListBase.H.


Member Data Documentation

const_iterator endConstIter [static]
 

const_iterator returned by end()

Definition at line 241 of file DLListBase.H.

iterator endIter [static]
 

iterator returned by end()

Definition at line 200 of file DLListBase.H.


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org