Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
dictionary
functionEntries
includeIfPresentEntry
includeIfPresentEntry.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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 <
OpenFOAM/includeEntry.H
>
45
46
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48
namespace
Foam
49
{
50
namespace
functionEntries
51
{
52
53
/*---------------------------------------------------------------------------*\
54
Class includeIfPresentEntry Declaration
55
\*---------------------------------------------------------------------------*/
56
57
class
includeIfPresentEntry
58
:
59
public
includeEntry
60
{
61
// Private Member Functions
62
63
//- Disallow default bitwise copy construct
64
includeIfPresentEntry
(
const
includeIfPresentEntry
&);
65
66
//- Disallow default bitwise assignment
67
void
operator=(
const
includeIfPresentEntry
&);
68
69
public
:
70
71
//- Runtime type information
72
ClassName
(
"includeIfPresent"
);
73
74
75
// Member Functions
76
77
//- Execute the functionEntry in a sub-dict context
78
static
bool
execute
(
dictionary
& parentDict,
Istream
&);
79
80
//- Execute the functionEntry in a primitiveEntry context
81
static
bool
execute
82
(
83
const
dictionary
& parentDict,
84
primitiveEntry
&,
85
Istream
&
86
);
87
88
};
89
90
91
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92
93
}
// End namespace functionEntries
94
}
// End namespace Foam
95
96
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97
98
#endif
99
100
// ************************ vim: set sw=4 sts=4 et: ************************ //