Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_XMLParameterListHelpers.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
00030 #define TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
00031 
00032 
00038 #include "Teuchos_ParameterList.hpp"
00039 #include "Teuchos_Comm.hpp"
00040 
00041 
00042 namespace Teuchos {
00043 
00044 
00058 TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlFile(
00059   const std::string &xmlFileName,
00060   Teuchos::ParameterList *paramList
00061   );
00062 
00080 TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlFileAndBroadcast(
00081   const std::string &xmlFileName,
00082   Teuchos::ParameterList *paramList,
00083   const Teuchos::Comm<int> &comm
00084   );
00085 
00093 RCP<ParameterList> getParametersFromXmlFile( const std::string &xmlFileName );
00094 
00095 
00108 TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlString(
00109   const std::string &xmlStr,
00110   Teuchos::ParameterList *paramList
00111   );
00112 
00113 
00121 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr );
00122 
00123 
00133 TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlOStream(
00134   const Teuchos::ParameterList &paramList,
00135   std::ostream &xmlOut
00136   );
00137 
00138 
00149 TEUCHOS_LIB_DLL_EXPORT void writeParameterListToXmlFile(
00150   const Teuchos::ParameterList &paramList,
00151   const std::string &xmlFileName
00152   );
00153 
00154 
00155 } // namespace Teuchos
00156 
00157 
00158 #endif // TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines