152 lines
3.5 KiB
C++
152 lines
3.5 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright held by original author
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by the
|
|
Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM; if not, write to the Free Software Foundation,
|
|
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
Class
|
|
Foam::className
|
|
|
|
Description
|
|
|
|
SourceFiles
|
|
classNameI.H
|
|
className.C
|
|
classNameIO.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef className_H
|
|
#define className_H
|
|
|
|
#include ".H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class Istream;
|
|
class Ostream;
|
|
|
|
// Forward declaration of friend functions and operators
|
|
class className;
|
|
Istream& operator>>(Istream&, className&);
|
|
Ostream& operator<<(Ostream&, const className&);
|
|
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class className Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class className
|
|
:
|
|
public baseClassName
|
|
{
|
|
// Private data
|
|
|
|
//- Description of data_
|
|
dataType data_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
className(const className&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const className&);
|
|
|
|
|
|
public:
|
|
|
|
// Static data members
|
|
|
|
//- Static data staticData
|
|
static const dataType staticData;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
className();
|
|
|
|
//- Construct from components
|
|
className(const dataType& data);
|
|
|
|
//- Construct from Istream
|
|
className(Istream&);
|
|
|
|
//- Construct as copy
|
|
className(const className&);
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Select null constructed
|
|
static autoPtr<className> New();
|
|
|
|
|
|
//- Destructor
|
|
~className();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
// Check
|
|
|
|
// Edit
|
|
|
|
// Write
|
|
|
|
|
|
// Member Operators
|
|
|
|
void operator=(const className&);
|
|
|
|
|
|
// Friend Functions
|
|
|
|
// Friend Operators
|
|
|
|
// IOstream Operators
|
|
|
|
friend Istream& operator>>(Istream&, className&);
|
|
friend Ostream& operator<<(Ostream&, const className&);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "classNameI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|