src/OpenFOAM/db/IOobjects/IOdictionary/IOdictionary.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::IOdictionary
  27
  28 Description
  29     IOdictionary is derived from dictionary and IOobject to give the
  30     dictionary automatic IO functionality via the objectRegistry.  To facilitate
  31     IO, IOdictioanry is provided with a constructor from IOobject and writeData
  32     and write functions.
  33
  34 SourceFiles
  35     IOdictionary.C
  36     IOdictionaryIO.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef IOdictionary_H
  41 #define IOdictionary_H
  42
  43 #include "dictionary.H"
  44 #include "regIOobject.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class IOdictionary Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class IOdictionary
  56 :
  57     public regIOobject,
  58     public dictionary
  59 {
  60
  61 public:
  62
  63     TypeName("dictionary");
  64
  65
  66     // Constructors
  67
  68         //- Construct given an IOobject
  69         IOdictionary(const IOobject&);
  70
  71         //- Construct given an IOobject and dictionary
  72         IOdictionary(const IOobject&, const dictionary&);
  73
  74
  75     // Destructor
  76
  77         virtual ~IOdictionary();
  78
  79
  80     // Member functions
  81
  82         //- Name function is needed to disambiguate those inherited
  83         //  from regIOobject and dictionary
  84         const word& name() const;
  85
  86         //- ReadData function required for regIOobject read operation
  87         bool readData(Istream&);
  88
  89         //- WriteData function required for regIOobject write operation
  90         bool writeData(Ostream&) const;
  91
  92
  93     // Member operators
  94
  95         //- Assignment of other IOdictionary's entries to this IOdictionary
  96         void operator=(const IOdictionary&);
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //