endifEntry.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::endifEntry
26 
27 Description
28  Part of the #if...#endif clause
29 
30 See also
31  Foam::functionEntries::ifEntry
32  Foam::functionEntries::ifeqEntry
33 
34 SourceFiles
35  endifEntry.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef endifEntry_H
40 #define endifEntry_H
41 
42 #include "functionEntry.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace functionEntries
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class endifEntry Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class endifEntry
56 :
57  public functionEntry
58 {
59 
60 public:
61 
62  //- Runtime type information
63  FunctionTypeName("#endif");
64 
65 
66  // Constructors
67 
68  //- Construct from line number, dictionary and Istream
70  (
71  const label lineNumber,
72  const dictionary& parentDict,
73  Istream& is
74  );
75 
76  //- Copy construct
77  endifEntry(const endifEntry&) = default;
78 
79  //- Clone
80  virtual autoPtr<entry> clone(const dictionary&) const
81  {
82  return autoPtr<entry>(new endifEntry(*this));
83  }
84 
85 
86  // Member Functions
87 
88  //- Expand the functionEntry into the contextDict
89  virtual bool execute(dictionary& contextDict, Istream& is)
90  {
92  return false;
93  }
94 
95 
96  // Member Operators
97 
98  //- Disallow default bitwise assignment
99  void operator=(const endifEntry&) = delete;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace functionEntries
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
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...#endif clause.
Definition: endifEntry.H:57
void operator=(const endifEntry &)=delete
Disallow default bitwise assignment.
virtual bool execute(dictionary &contextDict, Istream &is)
Expand the functionEntry into the contextDict.
Definition: endifEntry.H:88
endifEntry(const label lineNumber, const dictionary &parentDict, Istream &is)
Construct from line number, dictionary and Istream.
Definition: endifEntry.C:44
FunctionTypeName("#endif")
Runtime type information.
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