bin/foamTemplates/source/foamTemplate.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-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::className
  27
  28 Description
  29
  30 SourceFiles
  31     classNameI.H
  32     className.C
  33     classNameIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef className_H
  38 #define className_H
  39
  40 #include ".H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class Istream;
  49 class Ostream;
  50
  51 // Forward declaration of friend functions and operators
  52 class className;
  53 Istream& operator>>(Istream&, className&);
  54 Ostream& operator<<(Ostream&, const className&);
  55
  56
  57 /*---------------------------------------------------------------------------*\
  58                           Class className Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class className
  62 :
  63     public baseClassName
  64 {
  65     // Private data
  66
  67         //- Description of data_
  68         dataType data_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Disallow default bitwise copy construct
  74         className(const className&);
  75
  76         //- Disallow default bitwise assignment
  77         void operator=(const className&);
  78
  79
  80 public:
  81
  82     // Static data members
  83
  84         //- Static data staticData
  85         static const dataType staticData;
  86
  87
  88     // Constructors
  89
  90         //- Construct null
  91         className();
  92
  93         //- Construct from components
  94         className(const dataType& data);
  95
  96         //- Construct from Istream
  97         className(Istream&);
  98
  99         //- Construct as copy
 100         className(const className&);
 101
 102
 103     // Selectors
 104
 105         //- Select null constructed
 106         static autoPtr<className> New();
 107
 108
 109     //- Destructor
 110     ~className();
 111
 112
 113     // Member Functions
 114
 115         // Access
 116
 117         // Check
 118
 119         // Edit
 120
 121         // Write
 122
 123
 124     // Member Operators
 125
 126         void operator=(const className&);
 127
 128
 129     // Friend Functions
 130
 131     // Friend Operators
 132
 133     // IOstream Operators
 134
 135         friend Istream& operator>>(Istream&, className&);
 136         friend Ostream& operator<<(Ostream&, const className&);
 137 };
 138
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 } // End namespace Foam
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #include "classNameI.H"
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #endif
 151
 152 // ************************************************************************* //