Teuchos_XMLParameterListHelpers.hpp File Reference

Simple helper functions that make it easy to read and write XML to and from a parameterlist. More...

#include "Teuchos_ParameterList.hpp"

Go to the source code of this file.

Namespaces
namespace	Teuchos
Functions
void	updateParametersFromXmlFile (const std::string &xmlFileName, Teuchos::ParameterList *paramList)
	Reads XML parameters from a file and updates those already in the given parameter list.
void	updateParametersFromXmlString (const std::string &xmlStr, Teuchos::ParameterList *paramList)
	Reads XML parameters from a string and updates those already in the given parameter list.
void	writeParameterListToXmlOStream (const Teuchos::ParameterList &paramList, std::ostream &xmlOut)
	Write parameters and sublists in XML format to an std::ostream.
void	writeParameterListToXmlFile (const Teuchos::ParameterList &paramList, const std::string &xmlFileName)
	Write parameters and sublist to an XML file.

---

Detailed Description

Simple helper functions that make it easy to read and write XML to and from a parameterlist.

Definition in file Teuchos_XMLParameterListHelpers.hpp.

---

Function Documentation

void Teuchos::updateParametersFromXmlFile (  const std::string &  xmlFileName, Teuchos::ParameterList *  paramList )

Reads XML parameters from a file and updates those already in the given parameter list. Parameters: xmlFileName  [in] The file name containing XML parameter list specification. paramList  [in/out] On input, *paramList may be empty or contain some parameters and sublists. On output, parameters and sublist from the file xmlFileName will be set or overide those in *paramList. Definition at line 35 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::updateParametersFromXmlString (  const std::string &  xmlStr, Teuchos::ParameterList *  paramList )

Reads XML parameters from a string and updates those already in the given parameter list. Parameters: xmlStr  [in] String containing XML parameter list specification. paramList  [in/out] On input, *paramList may be empty or contain some parameters and sublists. On output, parameters and sublist from the file xmlStr will be set or overide those in *paramList. Definition at line 47 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::writeParameterListToXmlOStream (  const Teuchos::ParameterList &  paramList, std::ostream &  xmlOut )

Write parameters and sublists in XML format to an std::ostream. Parameters: paramList  [in] Contains the parameters and sublists that will be written to file. xmlOut  [in] The stream that will get the XML output. Definition at line 59 of file Teuchos_XMLParameterListHelpers.cpp.

void Teuchos::writeParameterListToXmlFile (  const Teuchos::ParameterList &  paramList, const std::string &  xmlFileName )

Write parameters and sublist to an XML file. Parameters: paramList  [in] Contains the parameters and sublists that will be written to file. xmlFileName  [in] The file name that will be create to contain the XML version of the parameter list specification. Definition at line 69 of file Teuchos_XMLParameterListHelpers.cpp.

---