src/OpenFOAM/db/IOstreams/IOstreams/InfoProxy.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::InfoProxy
  27
  28 Description
  29     A helper class for outputting values to Ostream
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef InfoProxy_H
  34 #define InfoProxy_H
  35
  36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  37
  38 namespace Foam
  39 {
  40
  41 class Ostream;
  42
  43 /*---------------------------------------------------------------------------*\
  44                            Class InfoProxy Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 template<class T> class InfoProxy;
  48 template<class T> Ostream& operator<<(Ostream&, const InfoProxy<T>&);
  49
  50 template<class T>
  51 class InfoProxy
  52 {
  53 public:
  54
  55     const T& t_;
  56
  57     InfoProxy(const T& t)
  58     :
  59         t_(t)
  60     {}
  61
  62     friend Ostream& operator<< <T>
  63     (Ostream&, const InfoProxy<T>&);
  64 };
  65
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 } // End namespace Foam
  70
  71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  72
  73 #endif
  74
  75 // ************************************************************************* //