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::includeEntry 00026 00027 Description 00028 Specify an include file when reading dictionaries, expects a 00029 single string to follow. 00030 00031 An example of the @c \#include directive: 00032 @verbatim 00033 #include "includeFile" 00034 @endverbatim 00035 00036 The usual expansion of environment variables and other constructs 00037 (eg, the @c ~OpenFOAM/ expansion) is retained. 00038 00039 See Also 00040 fileName, string::expand() 00041 00042 SourceFiles 00043 includeEntry.C 00044 00045 \*---------------------------------------------------------------------------*/ 00046 00047 #ifndef includeEntry_H 00048 #define includeEntry_H 00049 00050 #include <OpenFOAM/functionEntry.H> 00051 00052 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00053 00054 namespace Foam 00055 { 00056 namespace functionEntries 00057 { 00058 00059 /*---------------------------------------------------------------------------*\ 00060 Class includeEntry Declaration 00061 \*---------------------------------------------------------------------------*/ 00062 00063 class includeEntry 00064 : 00065 public functionEntry 00066 { 00067 // Private Member Functions 00068 00069 //- Disallow default bitwise copy construct 00070 includeEntry(const includeEntry&); 00071 00072 //- Disallow default bitwise assignment 00073 void operator=(const includeEntry&); 00074 00075 protected: 00076 00077 // Protected Member Functions 00078 00079 //- Read the include fileName from Istream, expand and return 00080 static fileName includeFileName(Istream&); 00081 00082 00083 public: 00084 00085 //- Runtime type information 00086 ClassName("include"); 00087 00088 00089 // Member Functions 00090 00091 //- Execute the functionEntry in a sub-dict context 00092 static bool execute(dictionary& parentDict, Istream&); 00093 00094 //- Execute the functionEntry in a primitiveEntry context 00095 static bool execute 00096 ( 00097 const dictionary& parentDict, 00098 primitiveEntry&, 00099 Istream& 00100 ); 00101 00102 }; 00103 00104 00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00106 00107 } // End namespace functionEntries 00108 } // End namespace Foam 00109 00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00111 00112 #endif 00113 00114 // ************************ vim: set sw=4 sts=4 et: ************************ //
