src/OpenFOAM/db/IOstreams/token/CompoundToken.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::CompoundToken
  27
  28 Description
  29     An abstract base class for managing compound tokens
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef CompoundToken_H
  34 #define CompoundToken_H
  35
  36 #include "refCount.H"
  37 #include "typeInfo.H"
  38 #include "autoPtr.H"
  39 #include "runTimeSelectionTables.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 class CompoundToken;
  49 Ostream& operator<<(Ostream&, const CompoundToken&);
  50
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class CompoundToken Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class CompoundToken
  57 :
  58     public refCount
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         CompoundToken(const CompoundToken&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const CompoundToken&);
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     virtual const word& type() const = 0;
  73
  74
  75     // Declare run-time constructor selection tables
  76
  77         declareRunTimeSelectionTable
  78         (
  79             autoPtr,
  80             CompoundToken,
  81             Istream,
  82             (const word& type, Istream& is),
  83             (type, is)
  84         );
  85
  86
  87     // Constructors
  88
  89         //- Construct null
  90         CompoundToken()
  91         {}
  92
  93         //- Return the clone as this and increment reference count
  94         virtual autoPtr<CompoundToken> clone() const = 0;
  95
  96
  97     // Selectors
  98
  99         //- Select null constructed
 100         static autoPtr<CompoundToken> New(const word& type, Istream& is);
 101
 102
 103     // Destructor
 104
 105         virtual ~CompoundToken();
 106
 107
 108     // Member Functions
 109
 110         // Access
 111
 112         // Check
 113
 114         // Edit
 115
 116         // Write
 117
 118             virtual void write(Istream&) = 0;
 119
 120
 121     // IOstream Operators
 122
 123         friend Ostream& operator<<(Ostream&, const CompoundToken&);
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace Foam
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //