LIFOStack.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::LIFOStack
 
Description
    A LIFO stack based on a singly-linked list.
 
    Operations are push(), pop(), top(), bottom() and empty().
 
SourceFiles
    LIFOStack.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef LIFOStack_H
#define LIFOStack_H
 
#include "SLList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class LIFOStack Declaration
\*---------------------------------------------------------------------------*/
 
template<class T>
class LIFOStack
:
    public SLList<T>
{
 
public:
 
    // Constructors
 
        //- Construct null
        LIFOStack()
        {}
 
        //- Construct given initial T
        LIFOStack(T a)
        :
            SLList<T>(a)
        {}
 
        //- Construct from Istream
        LIFOStack(Istream& is)
        :
            SLList<T>(is)
        {}
 
 
    // Member Functions
 
        // Access
 
            //- Return a copy of the top element
            T top() const
            {
                return this->first();
            }
 
            //- Return a copy of the bottom element
            T bottom() const
            {
                return this->last();
            }
 
 
        // Edit
 
            //- Push an element onto the stack
            void push(const T& a)
            {
                this->insert(a);
            }
 
            //- Pop the top element off the stack
            T pop()
            {
                return this->removeHead();
            }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //