Teuchos_YamlParameterListCoreHelpers.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_YAML_PARAMETER_LIST_CORE_HELPERS_HPP
#define TEUCHOS_YAML_PARAMETER_LIST_CORE_HELPERS_HPP


#include "Teuchos_ParameterList.hpp"


namespace Teuchos {


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromYamlFile(
  const std::string &yamlFileName,
  const Ptr<ParameterList> &paramList
  );

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromYamlFile(const std::string &yamlFileName);

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void updateParametersFromYamlString(
  const std::string &yamlStr,
  const Ptr<ParameterList> &paramList, 
  bool overwrite,
  const std::string& name = ""
  );

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT 
void updateParametersFromYamlCString(
  const char* const data,
  const Teuchos::Ptr<Teuchos::ParameterList>& paramList,
  bool overwrite
  );



TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromYamlString(const std::string &yamlStr);


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToYamlOStream(
  const ParameterList &paramList,
  std::ostream &yamlOut
  );


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToYamlFile(
  const ParameterList &paramList,
  const std::string &yamlFileName
  );

} // namespace Teuchos


#endif // TEUCHOS_Yaml_PARAMETER_LIST_CORE_HELPERS_HPP