boolIO.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2023 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 Description
25  Reads an bool from an input stream, for a given version number and file
26  format. If an ASCII file is being read, then the line numbers are counted
27  and an erroneous read is reported.
28 
29 \*---------------------------------------------------------------------------*/
30 
31 #include "error.H"
32 
33 #include "bool.H"
34 #include "Switch.H"
35 #include "IOstreams.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 Foam::word Foam::name(const bool b)
40 {
41  return b ? "true" : "false";
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
48 {
49  if (is.good())
50  {
51  b = Switch(is);
52  }
53 
54  return is;
55 }
56 
57 
59 {
60  os.write(name(b));
61  os.check("Ostream& operator<<(Ostream&, const bool)");
62  return os;
63 }
64 
65 
67 {
68  bool b;
69  is >> b;
70 
71  return b;
72 }
73 
74 
75 // ************************************************************************* //
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
System bool.
virtual bool check(const char *operation) const
Check IOstream status for given operation.
Definition: IOstream.C:92
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:330
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
virtual Ostream & write(const char)=0
Write character.
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:61
A class for handling words, derived from string.
Definition: word.H:62
volScalarField & b
Definition: createFields.H:25
bool readBool(Istream &)
Definition: boolIO.C:66
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
Istream & operator>>(Istream &, pistonPointEdgeData &)
Ostream & operator<<(Ostream &os, const fvConstraints &constraints)