Teuchos - Trilinos Tools Package Version of the Day
Teuchos_XMLParameterListHelpers.cpp
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   ParameterList *paramList
00054   )
00055 {
00056   TEST_FOR_EXCEPT(paramList==NULL);
00057   XMLParameterListReader xmlPLReader;
00058   FileInputSource xmlFile(xmlFileName);
00059   XMLObject xmlParams = xmlFile.getObject();
00060   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00061 }
00062 
00063 
00064 void Teuchos::updateParametersFromXmlFileAndBroadcast(
00065   const std::string &xmlFileName,
00066   ParameterList *paramList,
00067   const Comm<int> &comm
00068   )
00069 {
00070   TEST_FOR_EXCEPT(paramList==NULL);
00071   if (comm.getSize()==1)
00072     updateParametersFromXmlFile(xmlFileName,paramList);
00073   else {
00074     if (comm.getRank()==0) {
00075       XMLParameterListReader xmlPLReader;
00076       FileInputSource xmlFile(xmlFileName);
00077       XMLObject xmlParams = xmlFile.getObject();
00078       std::string xmlString = toString(xmlParams);
00079       int strsize = xmlString.size();
00080       broadcast<int, int>(comm, 0, &strsize);
00081       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00082       updateParametersFromXmlString(xmlString, paramList);
00083     }
00084     else {
00085       int strsize;
00086       broadcast<int, int>(comm, 0, &strsize);
00087       std::string xmlString;
00088       xmlString.resize(strsize);
00089       broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
00090       updateParametersFromXmlString(xmlString, paramList);
00091     }
00092   }
00093 }
00094 
00095 
00096 Teuchos::RCP<Teuchos::ParameterList>
00097 Teuchos::getParametersFromXmlFile( const std::string &xmlFileName )
00098 {
00099   RCP<ParameterList> pl = parameterList();
00100   updateParametersFromXmlFile( xmlFileName, &*pl );
00101   return pl;
00102 }
00103 
00104 
00105 Teuchos::RCP<Teuchos::ParameterList>
00106 Teuchos::getParametersFromXmlFile(
00107   const std::string &xmlFileName,
00108   RCP<DependencySheet> depSheet)
00109 {
00110   XMLParameterListReader xmlPLReader;
00111   FileInputSource xmlFile(xmlFileName);
00112   XMLObject xmlParams = xmlFile.getObject();
00113   return xmlPLReader.toParameterList(xmlParams, depSheet);
00114 }
00115 
00116 
00117 void Teuchos::updateParametersFromXmlString(
00118   const std::string &xmlStr,
00119   ParameterList *paramList
00120   )
00121 {
00122   TEST_FOR_EXCEPT(paramList==NULL);
00123   XMLParameterListReader xmlPLReader;
00124   StringInputSource xmlStrSrc(xmlStr);
00125   XMLObject xmlParams = xmlStrSrc.getObject();
00126   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00127 }
00128 
00129 
00130 Teuchos::RCP<Teuchos::ParameterList>
00131 Teuchos::getParametersFromXmlString( const std::string &xmlStr )
00132 {
00133   RCP<ParameterList> pl = parameterList();
00134   updateParametersFromXmlString( xmlStr, &*pl );
00135   return pl;
00136 }
00137 
00138 
00139 Teuchos::RCP<Teuchos::ParameterList>
00140 Teuchos::getParametersFromXmlString( const std::string &xmlStr,
00141   RCP<DependencySheet> depSheet)
00142 {
00143   XMLParameterListReader xmlPLReader;
00144   StringInputSource xmlStrSrc(xmlStr);
00145   XMLObject xmlParams = xmlStrSrc.getObject();
00146   return xmlPLReader.toParameterList(xmlParams, depSheet);
00147 }
00148 
00149 
00150 void Teuchos::writeParameterListToXmlOStream(
00151   const ParameterList &paramList,
00152   std::ostream &xmlOut,
00153   RCP<const DependencySheet> depSheet
00154   )
00155 {
00156   XMLParameterListWriter plWriter;
00157   XMLObject xml = plWriter.toXML(paramList, depSheet);
00158   xmlOut << xml << std::endl;
00159 }
00160 
00161 
00162 void Teuchos::writeParameterListToXmlFile(
00163   const ParameterList &paramList,
00164   const std::string &xmlFileName,
00165   RCP<const DependencySheet> depSheet
00166   )
00167 {
00168   std::ofstream ofs(xmlFileName.c_str());
00169   writeParameterListToXmlOStream(paramList,ofs, depSheet);
00170 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines