FreeFOAM The Cross-Platform CFD Toolkit
Classes | Public Member Functions | Friends
SLListBase Class Reference

Base singly-linked list. More...

#include <OpenFOAM/SLListBase.H>

Detailed Description

Base singly-linked list.

Source files

Definition at line 51 of file SLListBase.H.

+ Inheritance diagram for SLListBase:

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

 SLListBase ()
 Null construct.
 SLListBase (link *)
 Construct given initial entry.
 ~SLListBase ()
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.
link * removeHead ()
 Remove and return head.
link * remove (link *)
link * remove (iterator &)
void clear ()
 Clear the list.
void transfer (SLListBase &)
 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

SLListBase ( )
inline

Null construct.

Definition at line 45 of file SLListBaseI.H.

SLListBase ( link *  a)
inline

Construct given initial entry.

Definition at line 52 of file SLListBaseI.H.

~SLListBase ( )
inline

Definition at line 61 of file SLListBaseI.H.

Member Function Documentation

Foam::label size ( ) const
inline

Return number of elements in list.

Definition at line 67 of file SLListBaseI.H.

Referenced by SLListBase::begin(), SLListBase::cbegin(), FixedList< T, Size >::FixedList(), FixedList< T, Size >::operator=(), List< T >::operator=(), Foam::polyMeshZipUpCells(), PtrList< T >::PtrList(), and PtrList< T >::read().

bool empty ( ) const
inline

Return true if the list is empty.

Definition at line 73 of file SLListBaseI.H.

Foam::SLListBase::link * first ( )
inline

Return first entry.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, and UILList< SLListBase, T >.

Definition at line 80 of file SLListBaseI.H.

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

Referenced by SLListBase::begin(), and SLListBase::cbegin().

const Foam::SLListBase::link * first ( ) const
inline

Return const access to first entry.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, and UILList< SLListBase, T >.

Definition at line 93 of file SLListBaseI.H.

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

Foam::SLListBase::link * last ( )
inline

Return last entry.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, and UILList< SLListBase, T >.

Definition at line 106 of file SLListBaseI.H.

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

const Foam::SLListBase::link * last ( ) const
inline

Return const access to last entry.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, and UILList< SLListBase, T >.

Definition at line 119 of file SLListBaseI.H.

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

void insert ( SLListBase::link *  a)

Add at head of list.

Definition at line 45 of file SLListBase.C.

References SLListBase::link::next_.

void append ( SLListBase::link *  a)

Add at tail of list.

Definition at line 62 of file SLListBase.C.

References SLListBase::link::next_.

Foam::SLListBase::link * removeHead ( )

Remove and return head.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, and UILList< SLListBase, T >.

Definition at line 78 of file SLListBase.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorIn, and SLListBase::link::next_.

Foam::SLListBase::link * remove ( SLListBase::link *  it)

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, and LList< SLListBase, word >.

Definition at line 104 of file SLListBase.C.

References SLListBase::link::next_, and p.

Foam::SLListBase::link * remove ( SLListBase::iterator &  it)
inline

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, and UILList< SLListBase, T >.

Definition at line 148 of file SLListBaseI.H.

void clear ( )
inline

Clear the list.

Reimplemented in LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, and ILList< SLListBase, T >.

Definition at line 131 of file SLListBaseI.H.

Referenced by SLListBase::transfer().

void transfer ( SLListBase &  lst)
inline

Transfer the contents of the argument into this List.

and annull the argument list.

Definition at line 138 of file SLListBaseI.H.

References SLListBase::clear().

Foam::SLListBase::iterator begin ( )
inline

Definition at line 225 of file SLListBaseI.H.

References SLListBase::first(), SLListBase::iterator, and SLListBase::size().

Referenced by cyclicGAMGInterface::cyclicGAMGInterface(), FixedList< T, Size >::FixedList(), List< T >::List(), FixedList< T, Size >::operator=(), List< T >::operator=(), argList::printUsage(), processorGAMGInterface::processorGAMGInterface(), PtrList< T >::PtrList(), and PtrList< T >::read().

const Foam::SLListBase::iterator & end ( )
inline

Definition at line 239 of file SLListBaseI.H.

Referenced by cyclicGAMGInterface::cyclicGAMGInterface(), FixedList< T, Size >::FixedList(), List< T >::List(), FixedList< T, Size >::operator=(), List< T >::operator=(), Foam::polyMeshZipUpCells(), processorGAMGInterface::processorGAMGInterface(), PtrList< T >::PtrList(), and PtrList< T >::read().

Foam::SLListBase::const_iterator cbegin ( ) const
inline

Definition at line 325 of file SLListBaseI.H.

References SLListBase::const_iterator, SLListBase::first(), and SLListBase::size().

Referenced by SLListBase::begin().

const Foam::SLListBase::const_iterator & cend ( ) const
inline

Definition at line 339 of file SLListBaseI.H.

Foam::SLListBase::const_iterator begin ( ) const
inline

Definition at line 346 of file SLListBaseI.H.

References SLListBase::cbegin().

const Foam::SLListBase::const_iterator & end ( ) const
inline

Definition at line 353 of file SLListBaseI.H.

Friends And Related Function Documentation

friend class iterator
friend

Reimplemented in LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, and UILList< SLListBase, T >.

Definition at line 94 of file SLListBase.H.

Referenced by SLListBase::begin().

friend class const_iterator
friend

Reimplemented in LPtrList< SLListBase, gasReaction >, LPtrList< SLListBase, T >, LPtrList< SLListBase, Reaction< ThermoType > >, LList< SLListBase, T >, LList< SLListBase, Reaction< ThermoType > * >, LList< SLListBase, string >, LList< SLListBase, gasReaction * >, LList< SLListBase, T * >, LList< SLListBase, label >, LList< SLListBase, word >, and UILList< SLListBase, T >.

Definition at line 97 of file SLListBase.H.

Referenced by SLListBase::cbegin().

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