InfoProxy.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::InfoProxy
26 
27 Description
28  A helper class for outputting values to Ostream
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef InfoProxy_H
33 #define InfoProxy_H
34 
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36 
37 namespace Foam
38 {
39 
40 class Ostream;
41 
42 /*---------------------------------------------------------------------------*\
43  Class InfoProxy Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class T> class InfoProxy;
47 template<class T> Ostream& operator<<(Ostream&, const InfoProxy<T>&);
48 
49 template<class T>
50 class InfoProxy
51 {
52 public:
53 
54  const T& t_;
55 
56  InfoProxy(const T& t)
57  :
58  t_(t)
59  {}
60 
61  friend Ostream& operator<< <T>
62  (Ostream&, const InfoProxy<T>&);
63 };
64 
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 } // End namespace Foam
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #endif
73 
74 // ************************************************************************* //
InfoProxy(const T &t)
Definition: InfoProxy.H:55
const T & t_
Definition: InfoProxy.H:53
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
A helper class for outputting values to Ostream.
Definition: InfoProxy.H:45
Namespace for OpenFOAM.