INew.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::INew
28 
29 Description
30  A helper class when constructing from an Istream or dictionary
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef INew_H
35 #define INew_H
36 
37 #include "autoPtr.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 // Forward declarations
45 class Istream;
46 
47 /*---------------------------------------------------------------------------*\
48  Class INew Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class T>
52 class INew
53 {
54 public:
55 
56  //- Construct null
57  INew()
58  {}
59 
60  //- New from Istream
61  autoPtr<T> operator()(Istream& is) const
62  {
63  return T::New(is);
64  }
65 
66  //- New from word (unused) and Istream
67  autoPtr<T> operator()(const word&, Istream& is) const
68  {
69  return T::New(is);
70  }
71 
72  //- New from dictionary
73  autoPtr<T> operator()(const dictionary& dict) const
74  {
75  return T::New(dict);
76  }
77 
78  //- New from word (unused) and dictionary
79  autoPtr<T> operator()(const word&, const dictionary& dict) const
80  {
81  return T::New(dict);
82  }
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::INew::INew
INew()
Construct null.
Definition: INew.H:56
Foam::INew::operator()
autoPtr< T > operator()(const word &, Istream &is) const
New from word (unused) and Istream.
Definition: INew.H:66
Foam::INew
A helper class when constructing from an Istream or dictionary.
Definition: INew.H:51
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::INew::operator()
autoPtr< T > operator()(const dictionary &dict) const
New from dictionary.
Definition: INew.H:72
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::INew::operator()
autoPtr< T > operator()(Istream &is) const
New from Istream.
Definition: INew.H:60
Foam::INew::operator()
autoPtr< T > operator()(const word &, const dictionary &dict) const
New from word (unused) and dictionary.
Definition: INew.H:78
autoPtr.H