FreeFOAM The Cross-Platform CFD Toolkit
FIFOStack< T > Class Template Reference

A FIFO stack based on a singly-linked list. Operations are push(), pop(), top(), bottom() and empty(). More...

#include <OpenFOAM/FIFOStack.H>


Detailed Description

template<class T>
class Foam::FIFOStack< T >

A FIFO stack based on a singly-linked list. Operations are push(), pop(), top(), bottom() and empty().

Source files

Definition at line 51 of file FIFOStack.H.

+ Inheritance diagram for FIFOStack< T >:
+ Collaboration diagram for FIFOStack< T >:

List of all members.

Public Member Functions

 FIFOStack ()
 Construct null.
 FIFOStack (T a)
 Construct given initial T.
 FIFOStack (Istream &is)
 Construct from Istream.
T top () const
 Return a copy of the top element.
T bottom () const
 Return a copy of the bottom element.
void push (const T &a)
 Push an element onto the stack.
T pop ()
 Pop the bottom element off the stack.
- Public Member Functions inherited from SLList< T >
 SLList ()
 Null construct.
 SLList (T a)
 Construct given initial T.
 SLList (Istream &is)
 Construct from Istream.
- Public Member Functions inherited from LList< SLListBase, T >
 LList ()
 Null construct.
 LList (T a)
 Construct given initial T.
 LList (Istream &)
 Construct from Istream.
 LList (const LList< SLListBase, T > &)
 Construct as copy.
 ~LList ()
Tfirst ()
 Return the first entry added.
const Tfirst () const
 Return const access to the first entry added.
Tlast ()
 Return the last entry added.
const Tlast () const
 Return const access to the last entry added.
void insert (const T &a)
 Add at head of list.
void append (const T &a)
 Add at tail of list.
T removeHead ()
 Remove and return head.
T remove (link *l)
 Remove and return element.
T remove (iterator &it)
 Remove and return element specified by iterator.
void clear ()
 Delete contents of list.
void transfer (LList< SLListBase, T > &)
 Transfer the contents of the argument into this List.
void operator= (const LList< SLListBase, T > &)
- Public Member Functions inherited from SLListBase
 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.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
void transfer (SLListBase &)
 Transfer the contents of the argument into this List.
iterator begin ()
const iteratorend ()
const_iterator cbegin () const
const const_iteratorcend () const
const_iterator begin () const
const const_iteratorend () const

Constructor & Destructor Documentation

FIFOStack ( )
inline

Construct null.

Definition at line 61 of file FIFOStack.H.

FIFOStack ( T  a)
inline

Construct given initial T.

Definition at line 65 of file FIFOStack.H.

FIFOStack ( Istream is)
inline

Construct from Istream.

Definition at line 71 of file FIFOStack.H.


Member Function Documentation

T top ( ) const
inline

Return a copy of the top element.

Definition at line 82 of file FIFOStack.H.

T bottom ( ) const
inline

Return a copy of the bottom element.

Definition at line 88 of file FIFOStack.H.

void push ( const T a)
inline

Push an element onto the stack.

Definition at line 97 of file FIFOStack.H.

T pop ( )
inline

Pop the bottom element off the stack.

Definition at line 103 of file FIFOStack.H.


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