00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::functionEntries::includeIfPresentEntry 00026 00027 Description 00028 Specify a file to include if it exists. Expects a single string to follow. 00029 00030 The @c \#includeIfPresent directive is similar to the @c \#include 00031 directive, but does not generate an error if the file does not exist. 00032 00033 See Also 00034 Foam::functionEntries::includeEntry 00035 00036 SourceFiles 00037 includeIfPresentEntry.C 00038 00039 \*---------------------------------------------------------------------------*/ 00040 00041 #ifndef includeIfPresentEntry_H 00042 #define includeIfPresentEntry_H 00043 00044 #include <OpenFOAM/includeEntry.H> 00045 00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00047 00048 namespace Foam 00049 { 00050 namespace functionEntries 00051 { 00052 00053 /*---------------------------------------------------------------------------*\ 00054 Class includeIfPresentEntry Declaration 00055 \*---------------------------------------------------------------------------*/ 00056 00057 class includeIfPresentEntry 00058 : 00059 public includeEntry 00060 { 00061 // Private Member Functions 00062 00063 //- Disallow default bitwise copy construct 00064 includeIfPresentEntry(const includeIfPresentEntry&); 00065 00066 //- Disallow default bitwise assignment 00067 void operator=(const includeIfPresentEntry&); 00068 00069 public: 00070 00071 //- Runtime type information 00072 ClassName("includeIfPresent"); 00073 00074 00075 // Member Functions 00076 00077 //- Execute the functionEntry in a sub-dict context 00078 static bool execute(dictionary& parentDict, Istream&); 00079 00080 //- Execute the functionEntry in a primitiveEntry context 00081 static bool execute 00082 ( 00083 const dictionary& parentDict, 00084 primitiveEntry&, 00085 Istream& 00086 ); 00087 00088 }; 00089 00090 00091 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00092 00093 } // End namespace functionEntries 00094 } // End namespace Foam 00095 00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00097 00098 #endif 00099 00100 // ************************ vim: set sw=4 sts=4 et: ************************ //
