bin/foamTemplates/sourceTemplate/foamTemplateTemplate.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 someClass;
  49
  50
  51 // Forward declaration of friend functions and operators
  52
  53 template<TemplateClassArgument>
  54 class ClassName;
  55
  56 template<TemplateClassArgument>
  57 Istream& operator>>(Istream&, ClassName<TemplateArgument>&);
  58
  59 template<TemplateClassArgument>
  60 Ostream& operator<<(Ostream&, const ClassName<TemplateArgument>&);
  61
  62
  63 /*---------------------------------------------------------------------------*\
  64                          Class ClassName Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 template<TemplateClassArgument>
  68 class ClassName
  69 :
  70     public baseClassName
  71 {
  72     // Private data
  73
  74         dataType data_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         ClassName(const ClassName<TemplateArgument>&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const ClassName<TemplateArgument>&);
  84
  85
  86 public:
  87
  88     // Static data members
  89
  90         //- Static data someStaticData
  91         static const dataType staticData;
  92
  93
  94     // Constructors
  95
  96         //- Construct null
  97         ClassName();
  98
  99         //- Construct from components
 100         ClassName(const dataType& data);
 101
 102         //- Construct from Istream
 103         ClassName(Istream&);
 104
 105         //- Construct as copy
 106         ClassName(const ClassName<TemplateArgument>&);
 107
 108
 109     // Selectors
 110
 111         //- Select null constructed
 112         static autoPtr<ClassName<TemplateArgument> > New();
 113
 114
 115     // Destructor
 116
 117         ~ClassName();
 118
 119
 120     // Member Functions
 121
 122     // Member Operators
 123
 124         void operator=(const ClassName<TemplateArgument>&);
 125
 126
 127     // Friend Functions
 128
 129     // Friend Operators
 130
 131     // IOstream Operators
 132
 133         friend Istream& operator>>
 134         #ifndef __CINT__
 135         <TemplateArgument>
 136         #endif
 137         (Istream&, ClassName<TemplateArgument>&);
 138
 139         friend Ostream& operator<<
 140         #ifndef __CINT__
 141         <TemplateArgument>
 142         #endif
 143         (Ostream&, const ClassName<TemplateArgument>&);
 144 };
 145
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 } // End namespace Foam
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #include "ClassNameI.H"
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #ifdef NoRepository
 158 #   include "ClassName.C"
 159 #endif
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 #endif
 164
 165 // ************************************************************************* //