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::removeEntry 00026 00027 Description 00028 Remove a dictionary entry. 00029 00030 The @c \#remove directive takes a list or a single wordRe. 00031 For example, 00032 @verbatim 00033 #remove entry0 00034 #remove ( entry1 entry2 entry3 otherEntry ) 00035 #remove "entry[1-3]" 00036 #remove ( "entry[1-3]" otherEntry ) 00037 @endverbatim 00038 00039 The removal only occurs in the current context. 00040 Removing sub-entries or parent entries is not supported. 00041 00042 SourceFiles 00043 removeEntry.C 00044 00045 \*---------------------------------------------------------------------------*/ 00046 00047 #ifndef removeEntry_H 00048 #define removeEntry_H 00049 00050 #include <OpenFOAM/functionEntry.H> 00051 00052 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00053 00054 namespace Foam 00055 { 00056 namespace functionEntries 00057 { 00058 00059 /*---------------------------------------------------------------------------*\ 00060 Class removeEntry Declaration 00061 \*---------------------------------------------------------------------------*/ 00062 00063 class removeEntry 00064 : 00065 public functionEntry 00066 { 00067 // Private Member Functions 00068 00069 //- Disallow default bitwise copy construct 00070 removeEntry(const removeEntry&); 00071 00072 //- Disallow default bitwise assignment 00073 void operator=(const removeEntry&); 00074 00075 00076 public: 00077 00078 //- Runtime type information 00079 ClassName("remove"); 00080 00081 00082 // Member Functions 00083 00084 //- Execute the functionEntry in a sub-dict context 00085 static bool execute(dictionary& parentDict, Istream&); 00086 }; 00087 00088 00089 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00090 00091 } // End namespace functionEntries 00092 } // End namespace Foam 00093 00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00095 00096 #endif 00097 00098 // ************************ vim: set sw=4 sts=4 et: ************************ //
