Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_XMLParameterListCoreHelpers.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Teuchos: Common Tools Package
4 //
5 // Copyright 2004 NTESS and the Teuchos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
11 #define TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
12 
13 
21 
22 
23 namespace Teuchos {
24 
25 
39 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(
40  const std::string &xmlFileName,
41  const Ptr<ParameterList> &paramList
42  );
43 
44 
53 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
54 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);
55 
56 
68 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
69 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
70  RCP<DependencySheet> depSheet);
71 
72 
89 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
90 void updateParametersFromXmlString(
91  const std::string &xmlStr,
92  const Ptr<ParameterList> &paramList,
93  bool overwrite = true
94  );
95 
96 
104 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
105 RCP<ParameterList> getParametersFromXmlString(const std::string &xmlStr);
106 
107 
117 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
118 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
119  RCP<DependencySheet> depSheet);
120 
121 
133 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
134 void writeParameterListToXmlOStream(
135  const ParameterList &paramList,
136  std::ostream &xmlOut,
137  RCP<const DependencySheet> depSheet = null
138  );
139 
140 
153 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
154 void writeParameterListToXmlFile(
155  const ParameterList &paramList,
156  const std::string &xmlFileName,
157  RCP<const DependencySheet> depSheet=null
158  );
159 
160 
161 } // namespace Teuchos
162 
163 
164 #endif // TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
Templated Parameter List class.
DataStructure keeping track of dependencies.