00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::FIFOStack 00026 00027 Description 00028 A FIFO stack based on a singly-linked list. 00029 Operations are push(), pop(), top(), bottom() and empty(). 00030 00031 SourceFiles 00032 FIFOStack.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef FIFOStack_H 00037 #define FIFOStack_H 00038 00039 #include <OpenFOAM/SLList.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class FIFOStack Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 template<class T> 00051 class FIFOStack 00052 : 00053 public SLList<T> 00054 { 00055 00056 public: 00057 00058 // Constructors 00059 00060 //- Construct null 00061 FIFOStack() 00062 {} 00063 00064 //- Construct given initial T 00065 FIFOStack(T a) 00066 : 00067 SLList<T>(a) 00068 {} 00069 00070 //- Construct from Istream 00071 FIFOStack(Istream& is) 00072 : 00073 SLList<T>(is) 00074 {} 00075 00076 00077 // Member Functions 00078 00079 // Access 00080 00081 //- Return a copy of the top element 00082 T top() const 00083 { 00084 return this->last(); 00085 } 00086 00087 //- Return a copy of the bottom element 00088 T bottom() const 00089 { 00090 return this->first(); 00091 } 00092 00093 00094 // Edit 00095 00096 //- Push an element onto the stack 00097 void push(const T& a) 00098 { 00099 this->append(a); 00100 } 00101 00102 //- Pop the bottom element off the stack 00103 T pop() 00104 { 00105 return this->removeHead(); 00106 } 00107 }; 00108 00109 00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00111 00112 } // End namespace Foam 00113 00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00115 00116 #endif 00117 00118 // ************************ vim: set sw=4 sts=4 et: ************************ //
