CompactIOList.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::CompactIOList
26 
27 Description
28  A List of objects of type <T> with automated input and output using
29  a compact storage. Behaves like IOList except when binary output in
30  case it writes a CompactListList.
31 
32  Useful for lists of small sublists e.g. faceList, cellList.
33 
34 SourceFiles
35  CompactIOList.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef CompactIOList_H
40 #define CompactIOList_H
41 
42 #include "IOList.H"
43 #include "regIOobject.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 class Istream;
51 class Ostream;
52 
53 // Forward declaration of friend functions and operators
54 template<class T, class BaseType> class CompactIOList;
55 
56 template<class T, class BaseType> Istream& operator>>
57 (
58  Istream&,
60 );
61 template<class T, class BaseType> Ostream& operator<<
62 (
63  Ostream&,
65 );
66 
67 /*---------------------------------------------------------------------------*\
68  Class CompactIOList Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 template<class T, class BaseType>
72 class CompactIOList
73 :
74  public regIOobject,
75  public List<T>
76 {
77  // Private Member Functions
78 
79  //- Read according to header type
80  void readFromStream();
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("CompactList");
86 
87 
88  // Constructors
89 
90  //- Construct from IOobject
91  CompactIOList(const IOobject&);
92 
93  //- Construct from IOobject and size of CompactIOList
94  CompactIOList(const IOobject&, const label);
95 
96  //- Construct from IOobject and a List
97  CompactIOList(const IOobject&, const List<T>&);
98 
99  //- Construct by transferring the List contents
100  CompactIOList(const IOobject&, const Xfer<List<T> >&);
101 
102 
103  // Destructor
104 
105  virtual ~CompactIOList();
106 
107 
108  // Member functions
109 
110  virtual bool writeObject
111  (
115  ) const;
116 
117  virtual bool writeData(Ostream&) const;
118 
119 
120  // Member operators
121 
123 
124  void operator=(const List<T>&);
125 
126 
127  // IOstream operators
128 
129  //- Read List from Istream, discarding contents of existing List.
130  friend Istream& operator>> <T, BaseType>
131  (
132  Istream&,
134  );
135 
136  // Write List to Ostream.
137  friend Ostream& operator<< <T, BaseType>
138  (
139  Ostream&,
141  );
142 };
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #ifdef NoRepository
152 # include "CompactIOList.C"
153 #endif
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
A List of objects of type <T> with automated input and output using a compact storage. Behaves like IOList except when binary output in case it writes a CompactListList.
Definition: CompactIOList.H:53
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
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
virtual bool writeData(Ostream &) const
Pure virtual writaData function.
Namespace for OpenFOAM.
CompactIOList(const IOobject &)
Construct from IOobject.
Definition: CompactIOList.C:64
virtual bool writeObject(IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
Write using given format, version and compression.
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
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
streamFormat
Enumeration for the format of data in the stream.
Definition: IOstream.H:86
compressionType
Enumeration for the format of data in the stream.
Definition: IOstream.H:193
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("CompactList")
Runtime type information.
Version number type.
Definition: IOstream.H:96
virtual ~CompactIOList()
void operator=(const CompactIOList< T, BaseType > &)