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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::simpleRegIOobject
28 
29 Description
30  Abstract base class for registered object with I/O. Used in debug symbol
31  registration.
32 
33 SourceFiles
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef simpleRegIOobject_H
38 #define simpleRegIOobject_H
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declarations
46 class Istream;
47 class Ostream;
48 
49 /*---------------------------------------------------------------------------*\
50  Class simpleRegIOobject Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 {
55 public:
56 
57  // Constructors
58 
59  //- Construct from objectregistry inserter and name
61  (
62  void (*fn)(const char* name, simpleRegIOobject*),
63  const char* name
64  )
65  {
66  (*fn)(name, this);
67  }
68 
69 
70  //- Destructor
71  virtual ~simpleRegIOobject() = default;
72 
73 
74  // Member Functions
75 
76  //- Read
77  virtual void readData(Istream& is) = 0;
78 
79  //- Write
80  virtual void writeData(Ostream& os) const = 0;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Foam::simpleRegIOobject::writeData
virtual void writeData(Ostream &os) const =0
Write.
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::simpleRegIOobject::~simpleRegIOobject
virtual ~simpleRegIOobject()=default
Destructor.
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::simpleRegIOobject::readData
virtual void readData(Istream &is)=0
Read.
Foam::simpleRegIOobject::simpleRegIOobject
simpleRegIOobject(void(*fn)(const char *name, simpleRegIOobject *), const char *name)
Construct from objectregistry inserter and name.
Definition: simpleRegIOobject.H:60
Foam::simpleRegIOobject
Abstract base class for registered object with I/O. Used in debug symbol registration.
Definition: simpleRegIOobject.H:52