Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_YamlParameterListCoreHelpers.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_YAML_PARAMETER_LIST_CORE_HELPERS_HPP
43#define TEUCHOS_YAML_PARAMETER_LIST_CORE_HELPERS_HPP
44
45
52
53
54namespace Teuchos {
55
56
70TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromYamlFile(
71 const std::string &yamlFileName,
72 const Ptr<ParameterList> &paramList
73 );
74
83TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
84RCP<ParameterList> getParametersFromYamlFile(const std::string &yamlFileName);
85
102TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
103void updateParametersFromYamlString(
104 const std::string &yamlStr,
105 const Ptr<ParameterList> &paramList,
106 bool overwrite,
107 const std::string& name = ""
108 );
109
110TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
111void updateParametersFromYamlCString(
112 const char* const data,
114 bool overwrite
115 );
116
117
118
126TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
127RCP<ParameterList> getParametersFromYamlString(const std::string &yamlStr);
128
129
139TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
140void writeParameterListToYamlOStream(
141 const ParameterList &paramList,
142 std::ostream &yamlOut
143 );
144
145
156TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
157void writeParameterListToYamlFile(
158 const ParameterList &paramList,
159 const std::string &yamlFileName
160 );
161
162} // namespace Teuchos
163
164
165#endif // TEUCHOS_Yaml_PARAMETER_LIST_CORE_HELPERS_HPP
Templated Parameter List class.
Simple wrapper class for raw pointers to single objects where no persisting relationship exists.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...