Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_XMLParameterListHelpers.hpp
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 #ifndef TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
00043 #define TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
00044 
00045 
00051 #include "Teuchos_ParameterList.hpp"
00052 #include "Teuchos_DependencySheet.hpp"
00053 #include "Teuchos_Comm.hpp"
00054 
00055 
00056 namespace Teuchos {
00057 
00058 
00072 TEUCHOS_LIB_DLL_EXPORT void updateParametersFromXmlFile(
00073   const std::string &xmlFileName,
00074   ParameterList *paramList
00075   );
00076 
00094 TEUCHOS_LIB_DLL_EXPORT
00095 void updateParametersFromXmlFileAndBroadcast(
00096   const std::string &xmlFileName,
00097   ParameterList *paramList,
00098   const Comm<int> &comm
00099   );
00100 
00109 TEUCHOS_LIB_DLL_EXPORT 
00110 RCP<ParameterList> getParametersFromXmlFile( const std::string &xmlFileName );
00111 
00123 TEUCHOS_LIB_DLL_EXPORT
00124 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
00125   RCP<DependencySheet> depSheet);
00126 
00127 
00140 TEUCHOS_LIB_DLL_EXPORT
00141 void updateParametersFromXmlString(
00142   const std::string &xmlStr,
00143   ParameterList *paramList
00144   );
00145 
00146 
00154 TEUCHOS_LIB_DLL_EXPORT
00155 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr );
00156 
00166 TEUCHOS_LIB_DLL_EXPORT
00167 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
00168   RCP<DependencySheet> depSheet);
00169 
00170 
00182 TEUCHOS_LIB_DLL_EXPORT
00183 void writeParameterListToXmlOStream(
00184   const ParameterList &paramList,
00185   std::ostream &xmlOut,
00186   RCP<const DependencySheet> depSheet = null
00187   );
00188 
00189 
00202 TEUCHOS_LIB_DLL_EXPORT
00203 void writeParameterListToXmlFile(
00204   const ParameterList &paramList,
00205   const std::string &xmlFileName,
00206   RCP<const DependencySheet> depSheet=null
00207   );
00208 
00209 
00210 } // namespace Teuchos
00211 
00212 
00213 #endif // TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines