Teuchos - Trilinos Tools Package 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   const Ptr<ParameterList> &paramList
00075   );
00076 
00077 
00094 TEUCHOS_LIB_DLL_EXPORT
00095 void updateParametersFromXmlFileAndBroadcast(
00096   const std::string &xmlFileName,
00097   const Ptr<ParameterList> &paramList,
00098   const Comm<int> &comm
00099   );
00100 
00101 
00110 TEUCHOS_LIB_DLL_EXPORT 
00111 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);
00112 
00113 
00125 TEUCHOS_LIB_DLL_EXPORT
00126 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
00127   RCP<DependencySheet> depSheet);
00128 
00129 
00142 TEUCHOS_LIB_DLL_EXPORT
00143 void updateParametersFromXmlString(
00144   const std::string &xmlStr,
00145   const Ptr<ParameterList> &paramList
00146   );
00147 
00148 
00156 TEUCHOS_LIB_DLL_EXPORT
00157 RCP<ParameterList> getParametersFromXmlString(const std::string &xmlStr);
00158 
00159 
00169 TEUCHOS_LIB_DLL_EXPORT
00170 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
00171   RCP<DependencySheet> depSheet);
00172 
00173 
00185 TEUCHOS_LIB_DLL_EXPORT
00186 void writeParameterListToXmlOStream(
00187   const ParameterList &paramList,
00188   std::ostream &xmlOut,
00189   RCP<const DependencySheet> depSheet = null
00190   );
00191 
00192 
00205 TEUCHOS_LIB_DLL_EXPORT
00206 void writeParameterListToXmlFile(
00207   const ParameterList &paramList,
00208   const std::string &xmlFileName,
00209   RCP<const DependencySheet> depSheet=null
00210   );
00211 
00212 
00213 //
00214 // Deprecated
00215 //
00216 
00217 
00219 TEUCHOS_DEPRECATED inline
00220 void updateParametersFromXmlFile(
00221   const std::string &xmlFileName,
00222   ParameterList *paramList
00223   )
00224 {
00225   updateParametersFromXmlFile(xmlFileName, ptr(paramList));
00226 }
00227 
00228 
00230 TEUCHOS_DEPRECATED inline
00231 void updateParametersFromXmlFileAndBroadcast(
00232   const std::string &xmlFileName,
00233   ParameterList *paramList,
00234   const Comm<int> &comm
00235   )
00236 {
00237   updateParametersFromXmlFileAndBroadcast(xmlFileName, ptr(paramList), comm);
00238 }
00239 
00240 
00242 TEUCHOS_DEPRECATED inline
00243 void updateParametersFromXmlString(
00244   const std::string &xmlStr,
00245   ParameterList *paramList
00246   )
00247 {
00248   updateParametersFromXmlString(xmlStr, ptr(paramList));
00249 }
00250 
00251 
00252 } // namespace Teuchos
00253 
00254 
00255 #endif // TEUCHOS_XML_PARAMETER_LIST_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines