Teuchos_XMLParameterListHelpers.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
#define TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP


#include "Teuchos_ParameterList.hpp"
#include "Teuchos_Comm.hpp"


namespace Teuchos {


TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlFile(
  const std::string &xmlFileName,
  Teuchos::ParameterList *paramList
  );

TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlFileAndBroadcast(
  const std::string &xmlFileName,
  Teuchos::ParameterList *paramList,
  const Teuchos::Comm<int> &comm
  );

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


TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlString(
  const std::string &xmlStr,
  Teuchos::ParameterList *paramList
  );


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


TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlOStream(
  const Teuchos::ParameterList &paramList,
  std::ostream &xmlOut
  );


TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlFile(
  const Teuchos::ParameterList &paramList,
  const std::string &xmlFileName
  );


} // namespace Teuchos


#endif // TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP