All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
includeIfPresentEntry.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) 2011-2019 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::includeIfPresentEntry
26 
27 Description
28  Specify a file to include if it exists. Expects a single string to follow.
29 
30  The \c \#includeIfPresent directive is similar to the \c \#include
31  directive, but does not generate an error if the file does not exist.
32 
33 See also
34  Foam::functionEntries::includeEntry
35 
36 SourceFiles
37  includeIfPresentEntry.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef includeIfPresentEntry_H
42 #define includeIfPresentEntry_H
43 
44 #include "includeEntry.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace functionEntries
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class includeIfPresentEntry Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public includeEntry
60 {
61 
62 public:
63 
64  //- Runtime type information
65  ClassName("includeIfPresent");
66 
67 
68  // Constructors
69 
70  //- Disallow default bitwise copy construction
72 
73 
74  // Member Functions
75 
76  //- Execute the functionEntry in a sub-dict context
77  static bool execute(dictionary& parentDict, Istream&);
78 
79  //- Execute the functionEntry in a primitiveEntry context
80  static bool execute
81  (
82  const dictionary& parentDict,
84  Istream&
85  );
86 
87 
88  // Member Operators
89 
90  //- Disallow default bitwise assignment
91  void operator=(const includeIfPresentEntry&) = delete;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace functionEntries
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
static bool execute(dictionary &parentDict, Istream &)
Execute the functionEntry in a sub-dict context.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
includeIfPresentEntry(const includeIfPresentEntry &)=delete
Disallow default bitwise copy construction.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
ClassName("includeIfPresent")
Runtime type information.
A keyword and a list of tokens is a &#39;primitiveEntry&#39;. An primitiveEntry can be read, written and printed, and the types and values of its tokens analysed.
Specify an include file when reading dictionaries, expects a single string to follow.
Definition: includeEntry.H:62
void operator=(const includeIfPresentEntry &)=delete
Disallow default bitwise assignment.
Specify a file to include if it exists. Expects a single string to follow.
Namespace for OpenFOAM.