SwitchIO.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-2018 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 \*---------------------------------------------------------------------------*/
25 
26 #include "Switch.H"
27 #include "IOstreams.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
32 {
33  is >> *this;
34 }
35 
36 
37 // * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
38 
40 {
41  token t(is);
42 
43  if (!t.good())
44  {
45  is.setBad();
46  return is;
47  }
48 
49  if (t.isLabel())
50  {
51  s = bool(t.labelToken());
52  }
53  else if (t.isWord())
54  {
55  // allow invalid values, but catch after for correct error message
56  Switch sw(t.wordToken(), true);
57 
58  if (sw.valid())
59  {
60  s = sw;
61  }
62  else
63  {
64  is.setBad();
66  << "expected 'true/false', 'on/off' ... found " << t.wordToken()
67  << exit(FatalIOError);
68 
69  return is;
70  }
71  }
72  else
73  {
74  is.setBad();
76  << "wrong token type - expected bool, found " << t
77  << exit(FatalIOError);
78 
79  return is;
80  }
81 
82 
83  // Check state of Istream
84  is.check("Istream& operator>>(Istream&, Switch&)");
85 
86  return is;
87 }
88 
89 
91 {
92  os << Switch::names[int(s.switch_)];
93  os.check("Ostream& operator<<(Ostream&, const Switch&)");
94  return os;
95 }
96 
97 
98 // ************************************************************************* //
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
virtual bool check(const char *operation) const
Check IOstream status for given operation.
Definition: IOstream.C:92
void setBad()
Set stream to be bad.
Definition: IOstream.H:484
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
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Definition: Switch.H:61
bool valid() const
Return true if the Switch has a valid value.
Definition: Switch.C:123
Switch()
Construct null as false.
Definition: Switch.H:128
A token holds items read from Istream.
Definition: token.H:73
bool isLabel() const
Definition: tokenI.H:392
label labelToken() const
Definition: tokenI.H:397
bool good() const
Definition: tokenI.H:228
bool isWord() const
Definition: tokenI.H:261
const word & wordToken() const
Definition: tokenI.H:266
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:318
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.name(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Istream & operator>>(Istream &, directionInfo &)
IOerror FatalIOError
Ostream & operator<<(Ostream &, const ensightPart &)