File size: 5,933 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Switch
Description
A simple wrapper around bool so that it can be read as a word:
true/false, on/off, yes/no, y/n, t/f, or none/any.
SourceFiles
Switch.C
SwitchIO.C
\*---------------------------------------------------------------------------*/
#ifndef Switch_H
#define Switch_H
#include "bool.H"
#include "word.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class Switch;
class dictionary;
Istream& operator>>(Istream&, Switch&);
Ostream& operator<<(Ostream&, const Switch&);
/*---------------------------------------------------------------------------*\
Class Switch Declaration
\*---------------------------------------------------------------------------*/
class Switch
{
public:
// Public data types
//- The various text representations for a switch value.
// These also correspond to the entries in names.
enum class switchType : unsigned char
{
False = 0,
True = 1,
off = 2,
on = 3,
no = 4,
yes = 5,
n = 6,
y = 7,
f = 8,
t = 9,
none = 10,
any = 11,
invalid
};
//- Number of switchTypes
static const unsigned char nSwitchType =
static_cast<unsigned char>(switchType::invalid) + 1;
//- Convert switchType to integer (unsigned char)
inline static unsigned char toInt(const switchType x)
{
return static_cast<unsigned char>(x);
}
//- Increment the switchType counter
inline friend switchType operator++(switchType& x)
{
return x = switchType(toInt(x) + 1);
}
private:
// Private Data
//- The logic and enumerated text representation stored as a single byte
switchType switch_;
// Static Data Members
//- The set of names corresponding to the switchType enumeration
// Includes an extra entry for "invalid".
static const char* names[nSwitchType];
// Static Member Functions
//- Return a switchType representation of a word
static switchType asEnum(const std::string&, const bool allowInvalid);
public:
// Constructors
//- Construct null as false
Switch()
:
switch_(switchType::False)
{}
//- Construct from enumerated value
Switch(const switchType sw)
:
switch_(sw)
{}
//- Construct from bool
Switch(const bool b)
:
switch_(b ? switchType::True : switchType::False)
{}
//- Construct from integer values (treats integer as bool value)
Switch(const int i)
:
switch_(i ? switchType::True : switchType::False)
{}
//- Construct from std::string, string, word
// Optionally allow bad words, and catch the error elsewhere
Switch(const std::string& str, const bool allowInvalid=false)
:
switch_(asEnum(str, allowInvalid))
{}
//- Construct from character array
// Optionally allow bad words, and catch the error elsewhere
Switch(const char* str, const bool allowInvalid=false)
:
switch_(asEnum(std::string(str), allowInvalid))
{}
//- Construct from Istream
Switch(Istream& is);
// Member Functions
//- Return true if the Switch has a valid value
bool valid() const;
//- Return a text representation of the Switch
const char* asText() const;
//- Update the value of the Switch if it is found in the dictionary
bool readIfPresent(const word&, const dictionary&);
// Member Operators
//- Conversion to bool
operator bool() const
{
return (toInt(switch_) & 0x1);
}
//- Assignment to enumerated value
void operator=(const switchType sw)
{
switch_ = sw;
}
//- Assignment to bool
void operator=(const bool b)
{
switch_ = (b ? switchType::True : switchType::False);
}
// IOstream Operators
friend Istream& operator>>(Istream&, Switch&);
friend Ostream& operator<<(Ostream&, const Switch&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|