Teuchos_XMLParameterListCoreHelpers.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_XML_PARAMETER_LIST_CORE_HELPERS_HPP
#define TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP


#include "Teuchos_ParameterList.hpp"
#include "Teuchos_DependencySheet.hpp"


namespace Teuchos {


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


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
  RCP<DependencySheet> depSheet);


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void updateParametersFromXmlString(
  const std::string &xmlStr,
  const Ptr<ParameterList> &paramList, 
  bool overwrite = true
  );


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlString(const std::string &xmlStr);


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
  RCP<DependencySheet> depSheet);


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToXmlOStream(
  const ParameterList &paramList,
  std::ostream &xmlOut,
  RCP<const DependencySheet> depSheet = null
  );


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToXmlFile(
  const ParameterList &paramList,
  const std::string &xmlFileName,
  RCP<const DependencySheet> depSheet=null
  );


} // namespace Teuchos


#endif // TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP