![]() |
|
00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2005 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 the 00013 Free Software Foundation; either version 2 of the License, or (at your 00014 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, write to the Free Software Foundation, 00023 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00024 00025 Class 00026 FIFOStack 00027 00028 Description 00029 FIFO stack based on a singly-linked list. 00030 Operations are push, pop, top and empty. 00031 00032 SourceFiles 00033 FIFOStack.C 00034 00035 \*---------------------------------------------------------------------------*/ 00036 00037 #ifndef FIFOStack_H 00038 #define FIFOStack_H 00039 00040 #include "SLList.H" 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class FIFOStack Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 template<class T> 00052 class FIFOStack 00053 : 00054 public SLList<T> 00055 { 00056 00057 public: 00058 00059 // Constructors 00060 00061 //- Construct null 00062 FIFOStack() 00063 {} 00064 00065 //- Construct given initial T 00066 FIFOStack(T a) 00067 : 00068 SLList<T>(a) 00069 {} 00070 00071 //- Construct from Istream 00072 FIFOStack(Istream& is) 00073 : 00074 SLList<T>(is) 00075 {} 00076 00077 00078 // Member Functions 00079 00080 // Access 00081 00082 //- Return a copy of the top element 00083 T top() const 00084 { 00085 return this->last(); 00086 } 00087 00088 //- Return a copy of the bottom element 00089 T bottom() const 00090 { 00091 return this->first(); 00092 } 00093 00094 00095 // Check 00096 00097 //- Is the stack empty 00098 bool empty() const 00099 { 00100 return this->size() == 0; 00101 } 00102 00103 00104 // Edit 00105 00106 //- Push an element onto the stack 00107 void push(const T& a) 00108 { 00109 this->append(a); 00110 } 00111 00112 //- Pop the bottom element 00113 T pop() 00114 { 00115 return this->removeHead(); 00116 } 00117 }; 00118 00119 00120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00121 00122 } // End namespace Foam 00123 00124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00125 00126 #endif 00127 00128 // ************************************************************************* //