Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_XMLParameterListCoreHelpers.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_CORE_HELPERS_HPP
00043 #define TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
00044 
00045 
00051 #include "Teuchos_ParameterList.hpp"
00052 #include "Teuchos_DependencySheet.hpp"
00053 
00054 
00055 namespace Teuchos {
00056 
00057 
00071 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(
00072   const std::string &xmlFileName,
00073   const Ptr<ParameterList> &paramList
00074   );
00075 
00076 
00085 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT 
00086 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);
00087 
00088 
00100 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00101 RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
00102   RCP<DependencySheet> depSheet);
00103 
00104 
00117 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00118 void updateParametersFromXmlString(
00119   const std::string &xmlStr,
00120   const Ptr<ParameterList> &paramList
00121   );
00122 
00123 
00131 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00132 RCP<ParameterList> getParametersFromXmlString(const std::string &xmlStr);
00133 
00134 
00144 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00145 RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
00146   RCP<DependencySheet> depSheet);
00147 
00148 
00160 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00161 void writeParameterListToXmlOStream(
00162   const ParameterList &paramList,
00163   std::ostream &xmlOut,
00164   RCP<const DependencySheet> depSheet = null
00165   );
00166 
00167 
00180 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
00181 void writeParameterListToXmlFile(
00182   const ParameterList &paramList,
00183   const std::string &xmlFileName,
00184   RCP<const DependencySheet> depSheet=null
00185   );
00186 
00187 
00188 } // namespace Teuchos
00189 
00190 
00191 #endif // TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines