src/OpenFOAM/db/IOobjects/IOMap/IOMap.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::IOMap
  27
  28 Description
  29     A Map of objects of type \<T\> with automated input and output.
  30
  31 SourceFiles
  32     IOMap.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef IOMap_H
  37 #define IOMap_H
  38
  39 #include <OpenFOAM/Map.H>
  40 #include <OpenFOAM/regIOobject.H>
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class IOMap Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class T>
  52 class IOMap
  53 :
  54     public regIOobject,
  55     public Map<T>
  56 {
  57
  58 public:
  59
  60     //- Runtime type information
  61     TypeName("Map");
  62
  63
  64     // Constructors
  65
  66         //- Construct from IOobject
  67         IOMap(const IOobject&);
  68
  69         //- Construct from IOobject and size of Map
  70         IOMap(const IOobject&, const label);
  71
  72         //- Construct from IOobject and a Map
  73         IOMap(const IOobject&, const Map<T>&);
  74
  75         //- Construct by transferring the Map contents
  76         IOMap(const IOobject&, const Xfer<Map<T> >&);
  77
  78
  79     // Destructor
  80
  81         virtual ~IOMap();
  82
  83
  84     // Member functions
  85
  86         bool writeData(Ostream&) const;
  87
  88
  89     // Member operators
  90
  91         //- Assignment of other IOMap's entries to this IOMap
  92         void operator=(const IOMap<T>&);
  93
  94         //- Assignment of other Map's entries to this IOMap
  95         void operator=(const Map<T>&);
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #ifdef NoRepository
 106 #   include <OpenFOAM/IOMap.C>
 107 #endif
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************ vim: set sw=4 sts=4 et: ************************ //