FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

DLListBase Class Reference

Base doubly-linked list. More...

#include <OpenFOAM/DLListBase.H>


Detailed Description

Base doubly-linked list.

Source files

Definition at line 51 of file DLListBase.H.

Inheritance diagram for DLListBase:
Collaboration diagram for DLListBase:

List of all members.

Classes

class  const_iterator
 An STL-conforming const_iterator. More...
class  iterator
 An STL-conforming iterator. More...
struct  link
 Link structure. More...

Public Member Functions

 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label  size () const
 Return number of elements in list.
bool  empty () const
 Return true if the list is empty.
link *  first ()
 Return first entry.
const link *  first () const
 Return const access to first entry.
link *  last ()
 Return last entry.
const link *  last () 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.
link *  removeHead ()
 Remove and return head.
link *  remove (link *)
 Remove and return element.
link *  remove (iterator &)
link *  replace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
link *  replace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void  clear ()
 Clear the list.
void  transfer (DLListBase &)
 Transfer the contents of the argument into this List.
iterator  begin ()
const iterator &  end ()
const_iterator  cbegin () const
const const_iterator &  cend () const
const_iterator  begin () const
const const_iterator &  end () const

Friends

class  iterator
class  const_iterator

Constructor & Destructor Documentation

DLListBase (  ) [inline]

Null construct.

Definition at line 37 of file DLListBaseI.H.

DLListBase ( link *   a  ) [inline]

Construct given initial entry.

Definition at line 45 of file DLListBaseI.H.

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

~DLListBase (  ) [inline]

Definition at line 58 of file DLListBaseI.H.


Member Function Documentation

bool empty (  ) const [inline]

Return true if the list is empty.

Definition at line 83 of file DLListBaseI.H.

Referenced by cellTable::combine(), and boundaryRegion::rename().

void insert ( DLListBase::link *   a  )

Add at head of list.

Definition at line 48 of file DLListBase.C.

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

void append ( DLListBase::link *   a  )

Add at tail of list.

Definition at line 68 of file DLListBase.C.

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

Referenced by dictionary::add(), and IOPosition< ParticleType >::readData().

bool swapUp ( DLListBase::link *   a  )

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

Definition at line 88 of file DLListBase.C.

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

bool swapDown ( DLListBase::link *   a  )

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

Definition at line 129 of file DLListBase.C.

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

Foam::DLListBase::link * replace ( DLListBase::link *   oldLink,
DLListBase::link *   newLink  
)

Replace oldLink with newLink and return element.

Definition at line 227 of file DLListBase.C.

References DLListBase::link::deregister(), DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by dictionary::add(), and dictionary::changeKeyword().

Foam::DLListBase::link * replace ( DLListBase::iterator &   oldIter,
DLListBase::link *   newLink  
) [inline]

Replace oldIter with newLink and return element.

Definition at line 171 of file DLListBaseI.H.

void clear (  ) [inline]

Clear the list.

Reimplemented in Cloud< ParticleType >, DsmcCloud< ParcelType >, dictionary, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, Cloud< BasicReactingParcel< ThermoType > >, DictionaryBase< DLPtrList< phase >, phase >, 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, trackedParticle >, ILList< DLListBase, dsmcParcel >, ILList< DLListBase, BasicReactingParcel< ThermoType > >, ILList< DLListBase, solidParticle >, ILList< DLListBase, BasicReactingMultiphaseParcel< ThermoType > >, ILList< DLListBase, parcel >, ILList< DLListBase, entry >, ILList< DLListBase, ParticleType >, ILList< DLListBase, CoalParcel< ThermoType > >, ILList< DLListBase, molecule >, ILList< DLListBase, basicKinematicParcel >, ILList< DLListBase, basicThermoParcel >, ILList< DLListBase, ParcelType >, LList< DLListBase, T >, LList< DLListBase, entry * >, LList< DLListBase, T * >, LList< DLListBase, phase * >, LList< DLListBase, autoPtr< regExp > >, LPtrList< DLListBase, T >, and LPtrList< DLListBase, phase >.

Definition at line 141 of file DLListBaseI.H.

Referenced by DLListBase::transfer().

void transfer ( DLListBase &   lst  ) [inline]

Transfer the contents of the argument into this List.

and annull the argument list.

Definition at line 149 of file DLListBaseI.H.

References DLListBase::clear().


Friends And Related Function Documentation


The documentation for this class was generated from the following files:
  • src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H
  • src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.C
  • src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBaseI.H