elseEntry.H
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) 2025 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 Class
25  Foam::functionEntries::elseEntry
26 
27 Description
28  Part of the #if...#else...#endif clause
29 
30 See also
31  Foam::functionEntries::ifEntry
32  Foam::functionEntries::ifeqEntry
33  Foam::functionEntries::endifEntry
34 
35 SourceFiles
36  elseEntry.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef elseEntry_H
41 #define elseEntry_H
42 
43 #include "functionEntry.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace functionEntries
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class elseEntry Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class elseEntry
57 :
58  public functionEntry
59 {
60 
61 public:
62 
63  //- Runtime type information
64  FunctionTypeName("#else");
65 
66 
67  // Constructors
68 
69  //- Construct from line number, dictionary and Istream
70  elseEntry
71  (
72  const label lineNumber,
73  const dictionary& parentDict,
74  Istream& is
75  );
76 
77  //- Copy construct
78  elseEntry(const elseEntry&) = default;
79 
80  //- Clone
81  virtual autoPtr<entry> clone(const dictionary&) const
82  {
83  return autoPtr<entry>(new elseEntry(*this));
84  }
85 
86 
87  // Member Functions
88 
89  //- Expand the functionEntry into the contextDict
90  virtual bool execute(dictionary& contextDict, Istream& is)
91  {
93  return false;
94  }
95 
96 
97  // Member Operators
98 
99  //- Disallow default bitwise assignment
100  void operator=(const elseEntry&) = delete;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace functionEntries
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
label lineNumber() const
Return current stream line number.
Definition: IOstream.H:450
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
virtual autoPtr< entry > clone() const
Construct on freestore as copy.
Definition: entry.C:56
Part of the if...else...#endif clause.
Definition: elseEntry.H:58
FunctionTypeName("#else")
Runtime type information.
elseEntry(const label lineNumber, const dictionary &parentDict, Istream &is)
Construct from line number, dictionary and Istream.
Definition: elseEntry.C:44
virtual bool execute(dictionary &contextDict, Istream &is)
Expand the functionEntry into the contextDict.
Definition: elseEntry.H:89
void operator=(const elseEntry &)=delete
Disallow default bitwise assignment.
A functionEntry causes entries to be added/manipulated on the specified dictionary given an input str...
Definition: functionEntry.H:66
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:381
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59