Teuchos - Trilinos Tools Package Version of the Day
Teuchos_XMLParameterListCoreHelpers.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_XMLParameterListCoreHelpers.hpp"
00044 #include "Teuchos_FileInputSource.hpp"
00045 #include "Teuchos_StringInputSource.hpp"
00046 #include "Teuchos_XMLParameterListReader.hpp"
00047 #include "Teuchos_XMLParameterListWriter.hpp"
00048 
00049 
00050 void Teuchos::updateParametersFromXmlFile(
00051   const std::string &xmlFileName,
00052   const Ptr<ParameterList> &paramList
00053   )
00054 {
00055   XMLParameterListReader xmlPLReader;
00056   xmlPLReader.setAllowsDuplicateSublists( false );
00057   FileInputSource xmlFile(xmlFileName);
00058   XMLObject xmlParams = xmlFile.getObject();
00059   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00060 }
00061 
00062 
00063 Teuchos::RCP<Teuchos::ParameterList>
00064 Teuchos::getParametersFromXmlFile(const std::string &xmlFileName)
00065 {
00066   RCP<ParameterList> pl = parameterList();
00067   updateParametersFromXmlFile(xmlFileName, pl.ptr());
00068   return pl;
00069 }
00070 
00071 
00072 Teuchos::RCP<Teuchos::ParameterList>
00073 Teuchos::getParametersFromXmlFile(
00074   const std::string &xmlFileName,
00075   RCP<DependencySheet> depSheet)
00076 {
00077   XMLParameterListReader xmlPLReader;
00078   xmlPLReader.setAllowsDuplicateSublists( false );
00079   FileInputSource xmlFile(xmlFileName);
00080   XMLObject xmlParams = xmlFile.getObject();
00081   return xmlPLReader.toParameterList(xmlParams, depSheet);
00082 }
00083 
00084 
00085 void Teuchos::updateParametersFromXmlString(
00086   const std::string &xmlStr,
00087   const Ptr<ParameterList> &paramList
00088   )
00089 {
00090   XMLParameterListReader xmlPLReader;
00091   xmlPLReader.setAllowsDuplicateSublists( false );
00092   StringInputSource xmlStrSrc(xmlStr);
00093   XMLObject xmlParams = xmlStrSrc.getObject();
00094   paramList->setParameters(xmlPLReader.toParameterList(xmlParams));
00095 }
00096 
00097 
00098 Teuchos::RCP<Teuchos::ParameterList>
00099 Teuchos::getParametersFromXmlString(const std::string &xmlStr)
00100 {
00101   RCP<ParameterList> pl = parameterList();
00102   updateParametersFromXmlString(xmlStr, pl.ptr());
00103   return pl;
00104 }
00105 
00106 
00107 Teuchos::RCP<Teuchos::ParameterList>
00108 Teuchos::getParametersFromXmlString(const std::string &xmlStr,
00109   RCP<DependencySheet> depSheet)
00110 {
00111   XMLParameterListReader xmlPLReader;
00112   xmlPLReader.setAllowsDuplicateSublists( false );
00113   StringInputSource xmlStrSrc(xmlStr);
00114   XMLObject xmlParams = xmlStrSrc.getObject();
00115   return xmlPLReader.toParameterList(xmlParams, depSheet);
00116 }
00117 
00118 
00119 void Teuchos::writeParameterListToXmlOStream(
00120   const ParameterList &paramList,
00121   std::ostream &xmlOut,
00122   RCP<const DependencySheet> depSheet
00123   )
00124 {
00125   XMLParameterListWriter plWriter;
00126   XMLObject xml = plWriter.toXML(paramList, depSheet);
00127   xmlOut << xml << std::endl;
00128 }
00129 
00130 
00131 void Teuchos::writeParameterListToXmlFile(
00132   const ParameterList &paramList,
00133   const std::string &xmlFileName,
00134   RCP<const DependencySheet> depSheet
00135   )
00136 {
00137   std::ofstream ofs(xmlFileName.c_str());
00138   writeParameterListToXmlOStream(paramList,ofs, depSheet);
00139 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines