FreeFOAM The Cross-Platform CFD Toolkit
FIFOStack.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::FIFOStack
26 
27 Description
28  A FIFO stack based on a singly-linked list.
29  Operations are push(), pop(), top(), bottom() and empty().
30 
31 SourceFiles
32  FIFOStack.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef FIFOStack_H
37 #define FIFOStack_H
38 
39 #include <OpenFOAM/SLList.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class FIFOStack Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class T>
51 class FIFOStack
52 :
53  public SLList<T>
54 {
55 
56 public:
57 
58  // Constructors
59 
60  //- Construct null
62  {}
63 
64  //- Construct given initial T
66  :
67  SLList<T>(a)
68  {}
69 
70  //- Construct from Istream
72  :
73  SLList<T>(is)
74  {}
75 
76 
77  // Member Functions
78 
79  // Access
80 
81  //- Return a copy of the top element
82  T top() const
83  {
84  return this->last();
85  }
86 
87  //- Return a copy of the bottom element
88  T bottom() const
89  {
90  return this->first();
91  }
92 
93 
94  // Edit
95 
96  //- Push an element onto the stack
97  void push(const T& a)
98  {
99  this->append(a);
100  }
101 
102  //- Pop the bottom element off the stack
103  T pop()
104  {
105  return this->removeHead();
106  }
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************ vim: set sw=4 sts=4 et: ************************ //