IOList.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-2019 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::IOList
26 
27 Description
28  A List of objects of type <T> with automated input and output.
29 
30 SourceFiles
31  IOList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef IOList_H
36 #define IOList_H
37 
38 #include "List.H"
39 #include "regIOobject.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class IOList Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class T>
51 class IOList
52 :
53  public regIOobject,
54  public List<T>
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("List");
61 
62 
63  // Constructors
64 
65  //- Construct from IOobject
66  IOList(const IOobject&);
67 
68  //- Construct from IOobject and size of IOList
69  IOList(const IOobject&, const label);
70 
71  //- Construct from IOobject and a List
72  IOList(const IOobject&, const List<T>&);
73 
74  //- Move construct by transferring the List contents
75  IOList(const IOobject&, List<T>&&);
76 
77  //- Copy constructor
78  IOList(const IOList<T>&);
79 
80  //- Move constructor
81  IOList(IOList<T>&&);
82 
83 
84  //- Destructor
85  virtual ~IOList();
86 
87 
88  // Member Functions
89 
90  bool writeData(Ostream&) const;
91 
92 
93  // Member Operators
94 
95  void operator=(const IOList<T>&);
96  void operator=(IOList<T>&&);
97 
98  void operator=(const List<T>&);
99  void operator=(List<T>&&);
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #ifdef NoRepository
110  #include "IOList.C"
111 #endif
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
virtual ~IOList()
Destructor.
Definition: IOList.C:150
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 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
A List of objects of type <T> with automated input and output.
Definition: IOList.H:50
void operator=(const IOList< T > &)
Definition: IOList.C:167
TypeName("List")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
IOList(const IOobject &)
Construct from IOobject.
Definition: IOList.C:31
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOList.C:158
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.