IOPtrList.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-2022 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::IOPtrList
26 
27 Description
28  A PtrList of objects of type <Type> with automated input and output.
29 
30 SourceFiles
31  IOPtrList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef IOPtrList_H
36 #define IOPtrList_H
37 
38 #include "IOList.H"
39 #include "PtrList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class IOPtrList Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class IOPtrList
52 :
53  public IOListBase<PtrList, IOPtrList, Type>
54 {
55 
56 public:
57 
58  // Public Static Data
59 
60  //- Does this object support re-reading?
61  static const bool rereading = true;
62 
63 
64  //- Runtime type information
65  TypeName("PtrList");
66 
67 
68  // Constructors
69 
70  //- Inherit constructors
72 
73  //- Construct from IOobject using given Istream constructor class
74  template<class INew>
75  IOPtrList(const IOobject&, const INew&);
76 
77 
78  // Member Operators
79 
80  //- Inherit assignment operators
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #ifdef NoRepository
92  #include "IOPtrList.C"
93 #endif
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
A helper class when constructing from an Istream or dictionary.
Definition: INew.H:50
A PtrList of objects of type <Type> with automated input and output.
Definition: IOPtrList.H:53
TypeName("PtrList")
Runtime type information.
static const bool rereading
Does this object support re-reading?
Definition: IOPtrList.H:60
IOPtrList(const IOobject &, const INew &)
Construct from IOobject using given Istream constructor class.
Definition: IOPtrList.C:32
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
Namespace for OpenFOAM.