File size: 4,063 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2019-2020 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::variable
Description
A variable is a word with support for additional characters, in particular
'$' and '/'.
SourceFiles
variable.C
\*---------------------------------------------------------------------------*/
#ifndef variable_H
#define variable_H
#include "word.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class variable;
class Istream;
class Ostream;
Istream& operator>>(Istream&, variable&);
Ostream& operator<<(Ostream&, const variable&);
/*---------------------------------------------------------------------------*\
Class variable Declaration
\*---------------------------------------------------------------------------*/
class variable
:
public word
{
// Private Member Functions
//- Strip invalid characters from this variable
inline void stripInvalid();
public:
// Static Data Members
static const char* const typeName;
static int debug;
//- An empty variable
static const variable null;
// Constructors
//- Construct null
inline variable();
//- Copy constructor
inline variable(const variable&);
//- Copy constructor of word
inline explicit variable(const word&);
//- Copy constructor of string
inline explicit variable(const string&, const bool doStripInvalid=true);
//- Copy constructor of std::string
inline explicit variable
(
const std::string&,
const bool doStripInvalid=true
);
//- Copy constructor of character array
inline explicit variable(const char*, const bool doStripInvalid=true);
//- Construct from Istream
// Words are treated as literals, strings with an auto-test
explicit variable(Istream&);
// Member Functions
//- Is this character valid for a variable
inline static bool valid(char);
// Member Operators
// Assignment
inline void operator=(const variable&);
inline void operator=(const word&);
inline void operator=(const string&);
inline void operator=(const std::string&);
inline void operator=(const char*);
// IOstream Operators
friend Istream& operator>>(Istream&, variable&);
friend Ostream& operator<<(Ostream&, const variable&);
};
void writeEntry(Ostream& os, const variable& value);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "variableI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|