src/OpenFOAM/db/dictionary/functionEntries/removeEntry/removeEntry.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::functionEntries::removeEntry
  27
  28 Description
  29     Remove a dictionary entry.
  30
  31     The @c \#remove directive takes a word or a list of words. For example,
  32     @verbatim
  33         #remove entry0
  34         #remove ( entry1 entry2 entry3 )
  35     @endverbatim
  36
  37     The removable only occurs in the current context.
  38     Removing sub-entries or parent entries is not supported.
  39
  40 SourceFiles
  41     removeEntry.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef removeEntry_H
  46 #define removeEntry_H
  47
  48 #include "functionEntry.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54 namespace functionEntries
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                            Class removeEntry Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class removeEntry
  62 :
  63     public functionEntry
  64 {
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise copy construct
  68         removeEntry(const removeEntry&);
  69
  70         //- Disallow default bitwise assignment
  71         void operator=(const removeEntry&);
  72
  73
  74 public:
  75
  76     //- Runtime type information
  77     TypeName("remove");
  78
  79
  80     // Member Functions
  81
  82         //- Execute the functionEntry in a sub-dict context
  83         static bool execute
  84         (
  85             dictionary& parentDict,
  86             Istream& is
  87         );
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace functionEntries
  94 } // End namespace Foam
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 #endif
  99
 100 // ************************************************************************* //