Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_XMLParameterListHelpers.cpp
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 #include "Teuchos_XMLParameterListHelpers.hpp"
00030 #include "Teuchos_FileInputSource.hpp"
00031 #include "Teuchos_StringInputSource.hpp"
00032 #include "Teuchos_XMLParameterListReader.hpp"
00033 #include "Teuchos_XMLParameterListWriter.hpp"
00034 #include "Teuchos_CommHelpers.hpp"
00035 
00036 
00037 void Teuchos::updateParametersFromXmlFile(
00038   const std::string &xmlFileName,
00039   Teuchos::ParameterList *paramList
00040   )
00041 {
00042   TEST_FOR_EXCEPT(paramList==NULL);
00043   Teuchos::XMLParameterListReader xmlPLReader;
00044   Teuchos::FileInputSource xmlFile(xmlFileName);
00045   Teuchos::XMLObject xmlParams = xmlFile.getObject();
00046   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00047 }
00048 
00049 
00050 void Teuchos::updateParametersFromXmlFileAndBroadcast(
00051   const std::string &xmlFileName,
00052   Teuchos::ParameterList *paramList,
00053   const Teuchos::Comm<int> &comm
00054   )
00055 {
00056   TEST_FOR_EXCEPT(paramList==NULL);
00057   if (comm.getSize()==1)
00058     updateParametersFromXmlFile(xmlFileName,paramList);
00059   else {
00060     if (comm.getRank()==0) {
00061       Teuchos::XMLParameterListReader xmlPLReader;
00062       Teuchos::FileInputSource xmlFile(xmlFileName);
00063       Teuchos::XMLObject xmlParams = xmlFile.getObject();
00064       std::string xmlString = Teuchos::toString(xmlParams);
00065       int strsize = xmlString.size();
00066       broadcast<int, int>(comm, 0, &strsize);
00067       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00068       Teuchos::updateParametersFromXmlString(xmlString, paramList);
00069     }
00070     else {
00071       int strsize;
00072       broadcast<int, int>(comm, 0, &strsize);
00073       std::string xmlString;
00074       xmlString.resize(strsize);
00075       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00076       Teuchos::updateParametersFromXmlString(xmlString, paramList);
00077     }
00078   }
00079 }
00080 
00081 
00082 Teuchos::RCP<Teuchos::ParameterList>
00083 Teuchos::getParametersFromXmlFile( const std::string &xmlFileName )
00084 {
00085   RCP<ParameterList> pl = parameterList();
00086   updateParametersFromXmlFile( xmlFileName, &*pl );
00087   return pl;
00088 }
00089 
00090 
00091 void Teuchos::updateParametersFromXmlString(
00092   const std::string &xmlStr,
00093   Teuchos::ParameterList *paramList
00094   )
00095 {
00096   TEST_FOR_EXCEPT(paramList==NULL);
00097   Teuchos::XMLParameterListReader xmlPLReader;
00098   Teuchos::StringInputSource xmlStrSrc(xmlStr);
00099   Teuchos::XMLObject xmlParams = xmlStrSrc.getObject();
00100   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00101 }
00102 
00103 
00104 Teuchos::RCP<Teuchos::ParameterList>
00105 Teuchos::getParametersFromXmlString( const std::string &xmlStr )
00106 {
00107   RCP<ParameterList> pl = parameterList();
00108   updateParametersFromXmlString( xmlStr, &*pl );
00109   return pl;
00110 }
00111 
00112 
00113 void Teuchos::writeParameterListToXmlOStream(
00114   const Teuchos::ParameterList &paramList,
00115   std::ostream &xmlOut
00116   )
00117 {
00118   Teuchos::XMLParameterListWriter plWriter;
00119   Teuchos::XMLObject xml = plWriter.toXML(paramList);
00120   xmlOut << xml << std::endl;
00121 }
00122 
00123 
00124 void Teuchos::writeParameterListToXmlFile(
00125   const Teuchos::ParameterList &paramList,
00126   const std::string &xmlFileName
00127   )
00128 {
00129   std::ofstream ofs(xmlFileName.c_str());
00130   writeParameterListToXmlOStream(paramList,ofs);
00131 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines