bool.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) 2011 OpenFOAM Foundation
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 Primitive
25  bool
26 
27 Description
28  System bool
29 
30 SourceFiles
31  boolIO.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef bool_H
36 #define bool_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 class Istream;
44 class Ostream;
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 Istream& operator>>(Istream&, bool&);
49 Ostream& operator<<(Ostream&, const bool);
50 
51 bool readBool(Istream&);
52 
53 } // End namespace Foam
54 
55 
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 
58 #include "pTraits.H"
59 
60 namespace Foam
61 {
62 
63 // template specialisation for pTraits<bool>
64 template<>
65 class pTraits<bool>
66 {
67  bool p_;
68 
69 public:
70 
71  //- Component type
72  typedef bool cmptType;
73 
74  // Member constants
75 
76  enum
77  {
78  dim = 3,
79  rank = 0,
80  nComponents = 1
81  };
82 
83 
84  // Static data members
85 
86  static const char* const typeName;
87  static const char* componentNames[];
88  static const bool zero;
89  static const bool one;
90 
91 
92  // Constructors
93 
94  //- Construct from primitive
95  explicit pTraits(const bool&);
96 
97  //- Construct from Istream
98  pTraits(Istream&);
99 
100 
101  // Member Functions
102 
103  //- Access to the bool value
104  operator bool() const
105  {
106  return p_;
107  }
108 
109  //- Access to the bool value
110  operator bool&()
111  {
112  return p_;
113  }
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:58
pTraits(const PrimitiveType &p)
Construct from primitive.
Definition: pTraits.H:61
Ostream & operator<<(Ostream &, const edgeMesh &)
Traits class for primitives.
Definition: pTraits.H:51
Istream & operator>>(Istream &, edgeMesh &)
bool readBool(Istream &)
static const bool one
Definition: bool.H:89
static const char *const typeName
Definition: bool.H:86
static const bool zero
Definition: bool.H:88
bool cmptType
Component type.
Definition: bool.H:72