Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_YamlParameterListCoreHelpers.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_YAML_PARAMETER_LIST_CORE_HELPERS_HPP
11 #define TEUCHOS_YAML_PARAMETER_LIST_CORE_HELPERS_HPP
12 
13 
20 
21 
22 namespace Teuchos {
23 
24 
39  const std::string &yamlFileName,
40  const Ptr<ParameterList> &paramList
41  );
42 
52 RCP<ParameterList> getParametersFromYamlFile(const std::string &yamlFileName);
53 
72  const std::string &yamlStr,
73  const Ptr<ParameterList> &paramList,
74  bool overwrite,
75  const std::string& name = ""
76  );
77 
80  const char* const data,
81  const Teuchos::Ptr<Teuchos::ParameterList>& paramList,
82  bool overwrite
83  );
84 
85 
86 
95 RCP<ParameterList> getParametersFromYamlString(const std::string &yamlStr);
96 
97 
109  const ParameterList &paramList,
110  std::ostream &yamlOut
111  );
112 
113 
126  const ParameterList &paramList,
127  const std::string &yamlFileName
128  );
129 
130 } // namespace Teuchos
131 
132 
133 #endif // TEUCHOS_Yaml_PARAMETER_LIST_CORE_HELPERS_HPP
void updateParametersFromYamlFile(const std::string &yamlFileName, const Teuchos::Ptr< Teuchos::ParameterList > &paramList)
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromYamlCString(const char *const data, const Teuchos::Ptr< Teuchos::ParameterList > &paramList, bool overwrite)
void writeParameterListToYamlOStream(const ParameterList &paramList, std::ostream &yamlOut)
Teuchos::RCP< Teuchos::ParameterList > getParametersFromYamlString(const std::string &yamlStr)
Templated Parameter List class.
void writeParameterListToYamlFile(const ParameterList &paramList, const std::string &yamlFileName)
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void updateParametersFromYamlString(const std::string &yamlData, const Teuchos::Ptr< Teuchos::ParameterList > &paramList, bool overwrite, const std::string &name)
Teuchos::RCP< Teuchos::ParameterList > getParametersFromYamlFile(const std::string &yamlFileName)
Simple wrapper class for raw pointers to single objects where no persisting relationship exists...