etc/codeTemplates/source/_Template.H

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