src/foam/db/IOobjects/IOMap/IOMap.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::IOMap
  26
  27 Description
  28     A Map of objects of type \<T\> with automated input and output.
  29
  30 SourceFiles
  31     IOMap.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef IOMap_H
  36 #define IOMap_H
  37
  38 #include "Map.H"
  39 #include "regIOobject.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class IOMap Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class T>
  51 class IOMap
  52 :
  53     public regIOobject,
  54     public Map<T>
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName("Map");
  61
  62
  63     // Constructors
  64
  65         //- Construct from IOobject
  66         IOMap(const IOobject&);
  67
  68         //- Construct from IOobject and size of Map
  69         IOMap(const IOobject&, const label);
  70
  71         //- Construct from IOobject and a Map
  72         IOMap(const IOobject&, const Map<T>&);
  73
  74         //- Construct by transferring the Map contents
  75         IOMap(const IOobject&, const Xfer<Map<T> >&);
  76
  77
  78     // Destructor
  79
  80         virtual ~IOMap();
  81
  82
  83     // Member functions
  84
  85         bool writeData(Ostream&) const;
  86
  87
  88     // Member operators
  89
  90         //- Assignment of other IOMap's entries to this IOMap
  91         void operator=(const IOMap<T>&);
  92
  93         //- Assignment of other Map's entries to this IOMap
  94         void operator=(const Map<T>&);
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #ifdef NoRepository
 105 #   include "IOMap.C"
 106 #endif
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //