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   const Ptr<ParameterList> &paramList
00054   )
00055 {
00056   XMLParameterListReader xmlPLReader;
00057   xmlPLReader.setAllowsDuplicateSublists( false );
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   const Ptr<ParameterList> &paramList,
00067   const Comm<int> &comm
00068   )
00069 {
00070   if (comm.getSize()==1)
00071     updateParametersFromXmlFile(xmlFileName, paramList);
00072   else {
00073     if (comm.getRank()==0) {
00074       XMLParameterListReader xmlPLReader;
00075       xmlPLReader.setAllowsDuplicateSublists( false );
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.ptr());
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   xmlPLReader.setAllowsDuplicateSublists( false );
00112   FileInputSource xmlFile(xmlFileName);
00113   XMLObject xmlParams = xmlFile.getObject();
00114   return xmlPLReader.toParameterList(xmlParams, depSheet);
00115 }
00116 
00117 
00118 void Teuchos::updateParametersFromXmlString(
00119   const std::string &xmlStr,
00120   const Ptr<ParameterList> &paramList
00121   )
00122 {
00123   XMLParameterListReader xmlPLReader;
00124   xmlPLReader.setAllowsDuplicateSublists( false );
00125   StringInputSource xmlStrSrc(xmlStr);
00126   XMLObject xmlParams = xmlStrSrc.getObject();
00127   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00128 }
00129 
00130 
00131 Teuchos::RCP<Teuchos::ParameterList>
00132 Teuchos::getParametersFromXmlString(const std::string &xmlStr)
00133 {
00134   RCP<ParameterList> pl = parameterList();
00135   updateParametersFromXmlString(xmlStr, pl.ptr());
00136   return pl;
00137 }
00138 
00139 
00140 Teuchos::RCP<Teuchos::ParameterList>
00141 Teuchos::getParametersFromXmlString(const std::string &xmlStr,
00142   RCP<DependencySheet> depSheet)
00143 {
00144   XMLParameterListReader xmlPLReader;
00145   xmlPLReader.setAllowsDuplicateSublists( false );
00146   StringInputSource xmlStrSrc(xmlStr);
00147   XMLObject xmlParams = xmlStrSrc.getObject();
00148   return xmlPLReader.toParameterList(xmlParams, depSheet);
00149 }
00150 
00151 
00152 void Teuchos::writeParameterListToXmlOStream(
00153   const ParameterList &paramList,
00154   std::ostream &xmlOut,
00155   RCP<const DependencySheet> depSheet
00156   )
00157 {
00158   XMLParameterListWriter plWriter;
00159   XMLObject xml = plWriter.toXML(paramList, depSheet);
00160   xmlOut << xml << std::endl;
00161 }
00162 
00163 
00164 void Teuchos::writeParameterListToXmlFile(
00165   const ParameterList &paramList,
00166   const std::string &xmlFileName,
00167   RCP<const DependencySheet> depSheet
00168   )
00169 {
00170   std::ofstream ofs(xmlFileName.c_str());
00171   writeParameterListToXmlOStream(paramList,ofs, depSheet);
00172 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines