IOMap.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, 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  virtual ~IOMap();
80 
81 
82  // Member functions
83 
84  bool writeData(Ostream&) const;
85 
86 
87  // Member operators
88 
89  //- Assignment of other IOMap's entries to this IOMap
90  void operator=(const IOMap<T>&);
91 
92  //- Assignment of other Map's entries to this IOMap
93  void operator=(const Map<T>&);
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104 # include "IOMap.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
IOMap(const IOobject &)
Construct from IOobject.
Definition: IOMap.C:31
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOMap.C:129
A HashTable to objects of type <T> with a label key.
Definition: Map.H:49
A simple container for copying or transferring objects of type <T>.
Definition: Xfer.H:85
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Namespace for OpenFOAM.
A Map of objects of type <T> with automated input and output.
Definition: IOMap.H:50
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
void operator=(const IOMap< T > &)
Assignment of other IOMap&#39;s entries to this IOMap.
Definition: IOMap.C:138
TypeName("Map")
Runtime type information.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual ~IOMap()
Destructor.
Definition: IOMap.C:122