OpenFOAM logo
Open Source CFD Toolkit

CompoundToken.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     CompoundToken
00027 
00028 Description
00029 
00030 SourceFiles
00031     CompoundTokenI.H
00032     CompoundToken.C
00033     CompoundTokenIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef CompoundToken_H
00038 #define CompoundToken_H
00039 
00040 #include "refCount.H"
00041 #include "typeInfo.H"
00042 #include "autoPtr.H"
00043 #include "runTimeSelectionTables.H"
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                            Class CompoundToken Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class CompoundToken
00055 :
00056     public refCount
00057 {
00058     // Private Member Functions
00059 
00060         //- Disallow default bitwise copy construct
00061         CompoundToken(const CompoundToken&);
00062 
00063         //- Disallow default bitwise assignment
00064         void operator=(const CompoundToken&);
00065 
00066 
00067 public:
00068 
00069     //- Runtime type information
00070     virtual const word& type() const = 0;
00071 
00072 
00073     // Declare run-time constructor selection tables
00074 
00075         declareRunTimeSelectionTable
00076         (
00077             autoPtr,
00078             CompoundToken,
00079             Istream,
00080             (const word& type, Istream& is),
00081             (type, is)
00082         );
00083 
00084 
00085     // Constructors
00086 
00087         //- Construct null
00088         CompoundToken()
00089         {}
00090 
00091         //- Return the clone as this and increment reference count
00092         virtual autoPtr<CompoundToken> clone() const = 0;
00093 
00094 
00095     // Selectors
00096 
00097         //- Select null constructed
00098         static autoPtr<CompoundToken> New(const word& type, Istream& is);
00099 
00100 
00101     // Destructor
00102 
00103         virtual ~CompoundToken();
00104 
00105 
00106     // Member Functions
00107 
00108         // Access
00109 
00110         // Check
00111 
00112         // Edit
00113 
00114         // Write
00115 
00116             virtual void write(Istream&) = 0;
00117 
00118 
00119     // IOstream Operators
00120 
00121       //friend Istream& operator>>(Istream&, CompoundToken&);
00122         friend Ostream& operator<<(Ostream&, const CompoundToken&);
00123 };
00124 
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 } // End namespace Foam
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 //#include "CompoundTokenI.H"
00133 
00134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00135 
00136 #endif
00137 
00138 // ************************************************************************* //
For further information go to www.openfoam.org