IOPtrList.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::IOPtrList
26 
27 Description
28  A PtrList of objects of type <T> 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 "PtrList.H"
39 #include "regIOobject.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class IOPtrList Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class T>
51 class IOPtrList
52 :
53  public regIOobject,
54  public PtrList<T>
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("PtrList");
61 
62 
63  // Constructors
64 
65  //- Construct from IOobject using given Istream constructor class
66  template<class INew>
67  IOPtrList(const IOobject&, const INew&);
68 
69  //- Construct from IOobject
70  IOPtrList(const IOobject&);
71 
72  //- Construct from IOobject with given size
73  IOPtrList(const IOobject&, const label);
74 
75  //- Construct from IOobject and a PtrList
76  IOPtrList(const IOobject&, const PtrList<T>&);
77 
78  //- Construct by transferring the PtrList contents
79  IOPtrList(const IOobject&, const Xfer<PtrList<T> >&);
80 
81 
82  //- Destructor
83  virtual ~IOPtrList();
84 
85 
86  // Member functions
87 
88  bool writeData(Ostream&) const;
89 
90 
91  // Member operators
92 
93  void operator=(const IOPtrList<T>&);
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104 # include "IOPtrList.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOPtrList.C:142
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:61
IOPtrList(const IOobject &, const INew &)
Construct from IOobject using given Istream constructor class.
Definition: IOPtrList.C:32
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
A PtrList of objects of type <T> with automated input and output.
Definition: IOPtrList.H:50
A helper class when constructing from an Istream or dictionary.
Definition: INew.H:49
Namespace for OpenFOAM.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
void operator=(const IOPtrList< T > &)
Definition: IOPtrList.C:151
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
virtual ~IOPtrList()
Destructor.
Definition: IOPtrList.C:135
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("PtrList")
Runtime type information.