Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
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
17
18
21
22
23namespace Teuchos {
24
25
39TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(
40 const std::string &xmlFileName,
41 const Ptr<ParameterList> &paramList
42 );
43
44
53TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
54RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);
55
56
68TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
69RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
70 RCP<DependencySheet> depSheet);
71
72
89TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
91 const std::string &xmlStr,
92 const Ptr<ParameterList> &paramList,
93 bool overwrite = true
94 );
95
96
104TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
106
107
117TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
119 RCP<DependencySheet> depSheet);
120
121
133TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
135 const ParameterList &paramList,
136 std::ostream &xmlOut,
137 RCP<const DependencySheet> depSheet = null
138 );
139
140
153TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
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
DataStructure keeping track of dependencies.
Templated Parameter List class.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlString(const std::string &xmlStr, const Ptr< ParameterList > &paramList, bool overwrite=true)
Reads XML parameters from a std::string and updates those already in the given parameter list.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToXmlOStream(const ParameterList &paramList, std::ostream &xmlOut, RCP< const DependencySheet > depSheet=null)
Write parameters and sublists in XML format to an std::ostream.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlFile(const std::string &xmlFileName, RCP< DependencySheet > depSheet)
Reads XML parameters from a file and return them in a new parameter list.
ParameterList()=default
Constructor.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(const std::string &xmlFileName, const Ptr< ParameterList > &paramList)
Reads XML parameters from a file and updates those already in the given parameter list.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlString(const std::string &xmlStr)
Reads XML parameters from a std::string and return them in a new parameter list.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToXmlFile(const ParameterList &paramList, const std::string &xmlFileName, RCP< const DependencySheet > depSheet=null)
Write parameters and sublist to an XML file.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlFile(const std::string &xmlFileName)
Reads XML parameters from a file and return them in a new parameter list.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlString(const std::string &xmlStr, RCP< DependencySheet > depSheet)
Reads XML parameters from a std::string and return them in a new parameter list.
Simple wrapper class for raw pointers to single objects where no persisting relationship exists.
Smart reference counting pointer class for automatic garbage collection.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...