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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 #include "Teuchos_XMLParameterListHelpers.hpp"
00044 #include "Teuchos_FileInputSource.hpp"
00045 #include "Teuchos_StringInputSource.hpp"
00046 #include "Teuchos_XMLParameterListReader.hpp"
00047 #include "Teuchos_XMLParameterListWriter.hpp"
00048 #include "Teuchos_CommHelpers.hpp"
00049 
00050 
00051 void Teuchos::updateParametersFromXmlFile(
00052   const std::string &xmlFileName,
00053   const Ptr<ParameterList> &paramList
00054   )
00055 {
00056   XMLParameterListReader xmlPLReader;
00057   FileInputSource xmlFile(xmlFileName);
00058   XMLObject xmlParams = xmlFile.getObject();
00059   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00060 }
00061 
00062 
00063 void Teuchos::updateParametersFromXmlFileAndBroadcast(
00064   const std::string &xmlFileName,
00065   const Ptr<ParameterList> &paramList,
00066   const Comm<int> &comm
00067   )
00068 {
00069   if (comm.getSize()==1)
00070     updateParametersFromXmlFile(xmlFileName, paramList);
00071   else {
00072     if (comm.getRank()==0) {
00073       XMLParameterListReader xmlPLReader;
00074       FileInputSource xmlFile(xmlFileName);
00075       XMLObject xmlParams = xmlFile.getObject();
00076       std::string xmlString = toString(xmlParams);
00077       int strsize = xmlString.size();
00078       broadcast<int, int>(comm, 0, &strsize);
00079       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00080       updateParametersFromXmlString(xmlString, paramList);
00081     }
00082     else {
00083       int strsize;
00084       broadcast<int, int>(comm, 0, &strsize);
00085       std::string xmlString;
00086       xmlString.resize(strsize);
00087       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00088       updateParametersFromXmlString(xmlString, paramList);
00089     }
00090   }
00091 }
00092 
00093 
00094 Teuchos::RCP<Teuchos::ParameterList>
00095 Teuchos::getParametersFromXmlFile(const std::string &xmlFileName)
00096 {
00097   RCP<ParameterList> pl = parameterList();
00098   updateParametersFromXmlFile(xmlFileName, pl.ptr());
00099   return pl;
00100 }
00101 
00102 
00103 Teuchos::RCP<Teuchos::ParameterList>
00104 Teuchos::getParametersFromXmlFile(
00105   const std::string &xmlFileName,
00106   RCP<DependencySheet> depSheet)
00107 {
00108   XMLParameterListReader xmlPLReader;
00109   FileInputSource xmlFile(xmlFileName);
00110   XMLObject xmlParams = xmlFile.getObject();
00111   return xmlPLReader.toParameterList(xmlParams, depSheet);
00112 }
00113 
00114 
00115 void Teuchos::updateParametersFromXmlString(
00116   const std::string &xmlStr,
00117   const Ptr<ParameterList> &paramList
00118   )
00119 {
00120   XMLParameterListReader xmlPLReader;
00121   StringInputSource xmlStrSrc(xmlStr);
00122   XMLObject xmlParams = xmlStrSrc.getObject();
00123   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00124 }
00125 
00126 
00127 Teuchos::RCP<Teuchos::ParameterList>
00128 Teuchos::getParametersFromXmlString(const std::string &xmlStr)
00129 {
00130   RCP<ParameterList> pl = parameterList();
00131   updateParametersFromXmlString(xmlStr, pl.ptr());
00132   return pl;
00133 }
00134 
00135 
00136 Teuchos::RCP<Teuchos::ParameterList>
00137 Teuchos::getParametersFromXmlString(const std::string &xmlStr,
00138   RCP<DependencySheet> depSheet)
00139 {
00140   XMLParameterListReader xmlPLReader;
00141   StringInputSource xmlStrSrc(xmlStr);
00142   XMLObject xmlParams = xmlStrSrc.getObject();
00143   return xmlPLReader.toParameterList(xmlParams, depSheet);
00144 }
00145 
00146 
00147 void Teuchos::writeParameterListToXmlOStream(
00148   const ParameterList &paramList,
00149   std::ostream &xmlOut,
00150   RCP<const DependencySheet> depSheet
00151   )
00152 {
00153   XMLParameterListWriter plWriter;
00154   XMLObject xml = plWriter.toXML(paramList, depSheet);
00155   xmlOut << xml << std::endl;
00156 }
00157 
00158 
00159 void Teuchos::writeParameterListToXmlFile(
00160   const ParameterList &paramList,
00161   const std::string &xmlFileName,
00162   RCP<const DependencySheet> depSheet
00163   )
00164 {
00165   std::ofstream ofs(xmlFileName.c_str());
00166   writeParameterListToXmlOStream(paramList,ofs, depSheet);
00167 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines