FreeFOAM The Cross-Platform CFD Toolkit
CompoundToken.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::CompoundToken
26 
27 Description
28  An abstract base class for managing compound tokens
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef CompoundToken_H
33 #define CompoundToken_H
34 
35 #include <OpenFOAM/refCount.H>
36 #include <OpenFOAM/typeInfo.H>
37 #include <OpenFOAM/autoPtr.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of friend functions and operators
46 
47 class CompoundToken;
48 Ostream& operator<<(Ostream&, const CompoundToken&);
49 
50 
51 /*---------------------------------------------------------------------------*\
52  Class CompoundToken Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public refCount
58 {
59  // Private Member Functions
60 
61  //- Disallow default bitwise copy construct
63 
64  //- Disallow default bitwise assignment
65  void operator=(const CompoundToken&);
66 
67 
68 public:
69 
70  //- Runtime type information
71  virtual const word& type() const = 0;
72 
73 
74  // Declare run-time constructor selection tables
75 
77  (
78  autoPtr,
80  Istream,
81  (const word& type, Istream& is),
82  (type, is)
83  );
84 
85 
86  // Constructors
87 
88  //- Construct null
90  {}
91 
92  //- Return the clone as this and increment reference count
93  virtual autoPtr<CompoundToken> clone() const = 0;
94 
95 
96  // Selectors
97 
98  //- Select null constructed
99  static autoPtr<CompoundToken> New(const word& type, Istream& is);
100 
101 
102  // Destructor
103 
104  virtual ~CompoundToken();
105 
106 
107  // Member Functions
108 
109  // Access
110 
111  // Check
112 
113  // Edit
114 
115  // Write
116 
117  virtual void write(Istream&) = 0;
118 
119 
120  // IOstream Operators
121 
122  friend Ostream& operator<<(Ostream&, const CompoundToken&);
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************ vim: set sw=4 sts=4 et: ************************ //