/usr/include/trilinos/Teuchos_XMLParameterListCoreHelpers.hpp is in libtrilinos-teuchos-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
#define TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
/*! \file Teuchos_XMLParameterListCoreHelpers.hpp \brief Simple helper functions
that make it easy to read and write XML to and from a parameterlist.
*/
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_DependencySheet.hpp"
namespace Teuchos {
/** \brief Reads XML parameters from a file and updates those already in the
* given parameter list.
*
* \param xmlFileName [in] The file name containing XML parameter list
* specification.
*
* \param paramList [in/out] On input, <tt>*paramList</tt> may be empty or
* contain some parameters and sublists. On output, parameters and sublist
* from the file <tt>xmlFileName</tt> will be set or overide those in
* <tt>*paramList</tt>.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(
const std::string &xmlFileName,
const Ptr<ParameterList> ¶mList
);
/** \brief Reads XML parameters from a file and return them in a new parameter
* list.
*
* \param xmlFileName [in] The file name containing XML parameter list
* specification.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName);
/** \brief Reads XML parameters from a file and return them in a new parameter
* list.
*
* \param xmlFileName [in] The file name containing XML parameter list
* specification.
*
* \param depSheet [out] The Dependency Sheet into which Dependencies should be
* placed.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlFile(const std::string &xmlFileName,
RCP<DependencySheet> depSheet);
/** \brief Reads XML parameters from a std::string and updates those already in the
* given parameter list.
*
* \param xmlStr [in] String containing XML parameter list specification.
*
* \param paramList [in/out] On input, <tt>*paramList</tt> may be empty or
* contain some parameters and sublists. On output, parameters and sublist
* from the file <tt>xmlStr</tt> will be set or override (or not) those in
* <tt>*paramList</tt> depending on the <tt>overwrite</tt> parameter.
*
* \param overwrite [in] If true, parameters and sublists in the <tt>xmlStr</tt>
* will override those in <tt>paramList</tt>. If false, any value set in
* <tt>paramList</tt> will be kept, only values not set will be updated.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void updateParametersFromXmlString(
const std::string &xmlStr,
const Ptr<ParameterList> ¶mList,
bool overwrite = true
);
/** \brief Reads XML parameters from a std::string and return them in a new
* parameter list.
*
* \param xmlStr [in] String containing XML parameter list specification.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlString(const std::string &xmlStr);
/** \brief Reads XML parameters from a std::string and return them in a new
* parameter list.
*
* \param xmlStr [in] String containing XML parameter list specification.
* \param depSheet [in] The Dependency Sheet into which Dependencies should be
* placed.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP<ParameterList> getParametersFromXmlString( const std::string &xmlStr,
RCP<DependencySheet> depSheet);
/** \brief Write parameters and sublists in XML format to an std::ostream.
*
* \param paramList [in] Contains the parameters and sublists that will be
* written to file.
*
* \param xmlOut [in] The stream that will get the XML output.
*
* \param depSheet [in] The Dependency Sheet which should be written out.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToXmlOStream(
const ParameterList ¶mList,
std::ostream &xmlOut,
RCP<const DependencySheet> depSheet = null
);
/** \brief Write parameters and sublist to an XML file.
*
* \param paramList [in] Contains the parameters and sublists that will be
* written to file.
*
* \param xmlFileName [in] The file name that will be create to contain the
* XML version of the parameter list specification.
*
* \param depSheet [in] The Dependency Sheet which should be written out.
*
* \relates ParameterList
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void writeParameterListToXmlFile(
const ParameterList ¶mList,
const std::string &xmlFileName,
RCP<const DependencySheet> depSheet=null
);
} // namespace Teuchos
#endif // TEUCHOS_XML_PARAMETER_LIST_CORE_HELPERS_HPP
|