simpleRegIOobject.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) 2012 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::simpleRegIOobject
26 
27 Description
28  Abstract base class for registered object with I/O. Used in debug symbol
29  registration.
30 
31 SourceFiles
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef simpleRegIOobject_H
36 #define simpleRegIOobject_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 // Forward declaration of classes
44 class Istream;
45 class Ostream;
46 
47 /*---------------------------------------------------------------------------*\
48  Class simpleRegIOobject Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53 public:
54 
55  // Constructors
56 
57  //- Construct from objectregistry inserter and name
59  (
60  void (*fn)(const char* name, simpleRegIOobject*),
61  const char* name
62  )
63  {
64  (*fn)(name, this);
65  }
66 
67 
68  //- Destructor
69  virtual ~simpleRegIOobject()
70  {};
71 
72 
73  // Member Functions
74 
75  //- Read
76  virtual void readData(Istream&) = 0;
77 
78  //- Write
79  virtual void writeData(Ostream&) const = 0;
80 
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
virtual ~simpleRegIOobject()
Destructor.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Namespace for OpenFOAM.
virtual void readData(Istream &)=0
Read.
Abstract base class for registered object with I/O. Used in debug symbol registration.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
virtual void writeData(Ostream &) const =0
Write.
simpleRegIOobject(void(*fn)(const char *name, simpleRegIOobject *), const char *name)
Construct from objectregistry inserter and name.