IOMap.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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  Is a global object; i.e. can be read from undecomposed case.
30 
31 SourceFiles
32  IOMap.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef IOMap_H
37 #define IOMap_H
38 
39 #include "Map.H"
40 #include "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  //- Move construct by transferring the Map contents
76  IOMap(const IOobject&, Map<T>&&);
77 
78  //- Move constructor
79  IOMap(IOMap<T>&&);
80 
81 
82  //- Destructor
83  virtual ~IOMap();
84 
85 
86  // Member Functions
87 
88  bool writeData(Ostream&) const;
89 
90  //- Is object global
91  virtual bool global() const
92  {
93  return true;
94  }
95 
96  //- Return complete path + object name if the file exists
97  // either in the case/processor or case otherwise null
98  virtual fileName filePath() const
99  {
100  return globalFilePath(type());
101  }
102 
103 
104  // Member Operators
105 
106  //- Assignment of other IOMap's entries to this IOMap
107  void operator=(const IOMap<T>&);
108 
109  //- Move assignment of other IOMap's entries to this IOMap
110  void operator=(IOMap<T>&&);
111 
112  //- Assignment of other Map's entries to this IOMap
113  void operator=(const Map<T>&);
114 
115  //- Move assignment of other Map's entries to this IOMap
116  void operator=(Map<T>&&);
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #ifdef NoRepository
127  #include "IOMap.C"
128 #endif
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
IOMap(const IOobject &)
Construct from IOobject.
Definition: IOMap.C:31
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
A class for handling file names.
Definition: fileName.H:79
virtual bool global() const
Is object global.
Definition: IOMap.H:90
A Map of objects of type <T> with automated input and output. Is a global object; i...
Definition: IOMap.H:51
TypeName("Map")
Runtime type information.
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOMap.C:148
fileName globalFilePath(const word &typeName) const
Helper for filePath that searches up if in parallel.
Definition: IOobject.C:392
virtual fileName filePath() const
Return complete path + object name if the file exists.
Definition: IOMap.H:97
virtual ~IOMap()
Destructor.
Definition: IOMap.C:141
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void operator=(const IOMap< T > &)
Assignment of other IOMap&#39;s entries to this IOMap.
Definition: IOMap.C:157
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:52
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
Namespace for OpenFOAM.
A HashTable to objects of type <T> with a label key.
Definition: Map.H:49