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-2009 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 list or a single wordRe.
  32     For example,
  33     @verbatim
  34         #remove entry0
  35         #remove ( entry1 entry2 entry3 otherEntry )
  36         #remove "entry[1-3]"
  37         #remove ( "entry[1-3]" otherEntry )
  38     @endverbatim
  39
  40     The removal only occurs in the current context.
  41     Removing sub-entries or parent entries is not supported.
  42
  43 SourceFiles
  44     removeEntry.C
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef removeEntry_H
  49 #define removeEntry_H
  50
  51 #include "functionEntry.H"
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 namespace Foam
  56 {
  57 namespace functionEntries
  58 {
  59
  60 /*---------------------------------------------------------------------------*\
  61                            Class removeEntry Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class removeEntry
  65 :
  66     public functionEntry
  67 {
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct
  71         removeEntry(const removeEntry&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const removeEntry&);
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     ClassName("remove");
  81
  82
  83     // Member Functions
  84
  85         //- Execute the functionEntry in a sub-dict context
  86         static bool execute(dictionary& parentDict, Istream&);
  87 };
  88
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 } // End namespace functionEntries
  93 } // End namespace Foam
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #endif
  98
  99 // ************************************************************************* //