src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.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::includeEntry
  27
  28 Description
  29     Specify an include file when reading dictionaries, expects a
  30     single string to follow.
  31
  32     An example of the @c \#include directive:
  33     @verbatim
  34         #include "includeFile"
  35     @endverbatim
  36
  37     The usual expansion of environment variables and other constructs
  38     (eg, the @c ~OpenFOAM/ expansion) is retained.
  39
  40 See Also
  41     fileName, string::expand()
  42
  43 SourceFiles
  44     includeEntry.C
  45
  46 \*---------------------------------------------------------------------------*/
  47
  48 #ifndef includeEntry_H
  49 #define includeEntry_H
  50
  51 #include "functionEntry.H"
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 namespace Foam
  56 {
  57 namespace functionEntries
  58 {
  59
  60 /*---------------------------------------------------------------------------*\
  61                         Class includeEntry Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 class includeEntry
  65 :
  66     public functionEntry
  67 {
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct
  71         includeEntry(const includeEntry&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const includeEntry&);
  75
  76 protected:
  77
  78     // Protected Member Functions
  79
  80         //- Read the include fileName from Istream, expand and return
  81         static fileName includeFileName(Istream&);
  82
  83
  84 public:
  85
  86     //- Runtime type information
  87     ClassName("include");
  88
  89
  90     // Member Functions
  91
  92         //- Execute the functionEntry in a sub-dict context
  93         static bool execute(dictionary& parentDict, Istream&);
  94
  95         //- Execute the functionEntry in a primitiveEntry context
  96         static bool execute
  97         (
  98             const dictionary& parentDict,
  99             primitiveEntry&,
 100             Istream&
 101         );
 102
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace functionEntries
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //