GlobalIOList.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) 2015-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::GlobalIOList
26 
27 Description
28  IOList with global data (so optionally read from master)
29 
30 SourceFiles
31  GlobalIOList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef GlobalIOList_H
36 #define GlobalIOList_H
37 
38 #include "List.H"
39 #include "regIOobject.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class GlobalIOList Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class GlobalIOList
52 :
53  public regIOobject,
54  public List<Type>
55 {
56 
57 public:
58 
59  TypeName("List");
60 
61 
62  // Constructors
63 
64  //- Construct from IOobject
65  GlobalIOList(const IOobject&);
66 
67  //- Construct from IOobject
68  GlobalIOList(const IOobject&, const label size);
69 
70  //- Construct from IOobject and a List
71  GlobalIOList(const IOobject&, const List<Type>&);
72 
73  //- Move construct by transferring the List contents
74  GlobalIOList(const IOobject&, List<Type>&&);
75 
76  //- Copy constructor
78 
79  //- Move constructor
81 
82 
83  //- Destructor
84  virtual ~GlobalIOList();
85 
86 
87  // Member Functions
88 
89  //- Is object global
90  virtual bool global() const
91  {
92  return true;
93  }
94 
95  //- Return complete path + object name if the file exists
96  // either in the case/processor or case otherwise null
97  virtual fileName filePath() const
98  {
99  return globalFilePath(type());
100  }
101 
102  //- ReadData function required for regIOobject read operation
103  virtual bool readData(Istream&);
104 
105  //- WriteData function required for regIOobject write operation
106  bool writeData(Ostream&) const;
107 
108 
109  // Member Operators
110 
111  void operator=(const GlobalIOList<Type>&);
113 
114  void operator=(const List<Type>&);
115  void operator=(List<Type>&&);
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #ifdef NoRepository
126 # include "GlobalIOList.C"
127 #endif
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
virtual bool global() const
Is object global.
Definition: GlobalIOList.H:89
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
bool writeData(Ostream &) const
WriteData function required for regIOobject write operation.
Definition: GlobalIOList.C:130
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
Definition: GlobalIOList.C:122
virtual fileName filePath() const
Return complete path + object name if the file exists.
Definition: GlobalIOList.H:96
fileName globalFilePath(const word &typeName) const
Helper for filePath that searches up if in parallel.
Definition: IOobject.C:392
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual ~GlobalIOList()
Destructor.
Definition: GlobalIOList.C:115
IOList with global data (so optionally read from master)
Definition: GlobalIOList.H:50
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
GlobalIOList(const IOobject &)
Construct from IOobject.
Definition: GlobalIOList.C:31
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
label size() const
Return the number of elements in the UList.
Definition: ListI.H:171
void operator=(const GlobalIOList< Type > &)
Definition: GlobalIOList.C:139
Namespace for OpenFOAM.