Teuchos::ParameterEntryXMLConverter Class Reference

A class used to convert parameter entries to xml and vice versa. More...

#include <Teuchos_ParameterEntryXMLConverter.hpp>

Inheritance diagram for Teuchos::ParameterEntryXMLConverter:

List of all members.

Public Member Functions
Converter Functions
ParameterEntry	fromXMLtoParameterEntry (const XMLObject &xmlObj) const
	Converts the given xml into a parameter entry.
XMLObject	fromParameterEntrytoXML (RCP< const ParameterEntry > entry, const std::string &name, const ParameterEntry::ParameterEntryID &id, const ValidatortoIDMap &validatorIDsMap) const
	Converts the given parameter entry to xml.
virtual any	getAny (const XMLObject &xmlObj) const =0
Attribute/Query Methods
virtual const std::string	getTypeAttributeValue () const =0
	Gets a string representing the value that should be assigned to the "type" attribute when converting a parameter entry to xml.
virtual const std::string	getValueAttributeValue (RCP< const ParameterEntry > entry) const =0
	Gets the value to be assigned to the "value" attribute when converting the paramter entry to xml.
static const std::string &	getTypeAttributeName ()
static const std::string &	getIdAttributeName ()
static const std::string &	getValueAttributeName ()

---

Detailed Description

A class used to convert parameter entries to xml and vice versa.

Definition at line 61 of file Teuchos_ParameterEntryXMLConverter.hpp.

---

Member Function Documentation

ParameterEntry Teuchos::ParameterEntryXMLConverter::fromXMLtoParameterEntry

(

const XMLObject &

xmlObj

)

const

Converts the given xml into a parameter entry.

Parameters:

xmlObj

The xml to be converted to a parameter entry.

Returns:

A ParameterEntry with the aspects specified by the xml.

Definition at line 52 of file Teuchos_ParameterEntryXMLConverter.cpp.

XMLObject Teuchos::ParameterEntryXMLConverter::fromParameterEntrytoXML	(	RCP< const ParameterEntry >	entry,
		const std::string &	name,
		const ParameterEntry::ParameterEntryID &	id,
		const ValidatortoIDMap &	validatorIDsMap
	)		const

Converts the given parameter entry to xml.

Parameters:

entry	The parameter entry to convert to xml.
name	The name associated with the parameter entry.

Returns:

An XMLObject representing the parameter entry.

Definition at line 108 of file Teuchos_ParameterEntryXMLConverter.cpp.

virtual const std::string Teuchos::ParameterEntryXMLConverter::getTypeAttributeValue

(

)

const [pure virtual]

Gets a string representing the value that should be assigned to the "type" attribute when converting a parameter entry to xml.

Returns:

The value to be assigned to the "type" attribute when converting a parameter entry to xml.

Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.

virtual const std::string Teuchos::ParameterEntryXMLConverter::getValueAttributeValue

(

RCP< const ParameterEntry >

entry

)

const [pure virtual]

Gets the value to be assigned to the "value" attribute when converting the paramter entry to xml.

Parameters:

entry

The entry being converted.

Returns:

The value to be assigned to the "value" attribute when converting the parameter entry to xml.

Implemented in Teuchos::StandardTemplatedParameterConverter< T >, and Teuchos::AnyParameterEntryConverter.

static const std::string& Teuchos::ParameterEntryXMLConverter::getTypeAttributeName

(

)

[inline, static]

Definition at line 114 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getIdAttributeName

(

)

[inline, static]

Definition at line 120 of file Teuchos_ParameterEntryXMLConverter.hpp.

static const std::string& Teuchos::ParameterEntryXMLConverter::getValueAttributeName

(

)

[inline, static]

Definition at line 126 of file Teuchos_ParameterEntryXMLConverter.hpp.

---

The documentation for this class was generated from the following files:

• Teuchos_ParameterEntryXMLConverter.hpp
• Teuchos_ParameterEntryXMLConverter.cpp