read.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) 2023 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 Global
25  Foam::read
26 
27 Description
28  Read a type from an Istream or string using the pTraits class.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef read_H
33 #define read_H
34 
35 #include "pTraits.H"
36 #include "IStringStream.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 template<typename Type>
46 inline Type read(const string& str)
47 {
48  return read<Type>(IStringStream(str)());
49 }
50 
51 template<typename Type>
52 inline Type read(const char* str)
53 {
54  return read<Type>(IStringStream(str)());
55 }
56 
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 } // End namespace Foam
61 
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63 
64 #endif
65 
66 // ************************************************************************* //
Foam::IStringStream
Input from memory buffer stream.
Definition: IStringStream.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::read
bool read(const char *, int32_t &)
Definition: int32IO.C:85