src/OpenFOAM/primitives/pTraits/pTraits.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::pTraits
  26
  27 Description
  28     Traits class for primitives.
  29
  30     All primitives need a specialised version of this class. The
  31     specialised version will normally also require a conversion
  32     method.
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef pTraits_H
  37 #define pTraits_H
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 class Istream;
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class pTraits Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class PrimitiveType>
  51 class pTraits
  52 :
  53     public PrimitiveType
  54 {
  55
  56 public:
  57
  58     // Constructors
  59
  60         //- Construct from primitive
  61         pTraits(const PrimitiveType& p)
  62         :
  63             PrimitiveType(p)
  64         {}
  65
  66         //- Construct from Istream
  67         pTraits(Istream& is)
  68         :
  69             PrimitiveType(is)
  70         {}
  71 };
  72
  73
  74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  75
  76 } // End namespace Foam
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 #endif
  81
  82 // ************************************************************************* //