An abstract base class for converting Dependencies to and from XML. More...

#include <Teuchos_DependencyXMLConverter.hpp>

Inheritance diagram for Teuchos::DependencyXMLConverter:

Converter Functions
RCP< Dependency >	fromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
	Converts a given XMLObject to a Dependency.
virtual RCP< Dependency >	convertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const =0
	Preforms any and all special xml conversion that is specific to a particular Dependency.
XMLObject	fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
	Converters a given ParameterEntryValidator to XML.
virtual void	convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const =0
	Preforms any and all special dependency conversion that is specific to a particlar Dependency.
Attribute/Query Functions
static const std::string &	getDependeeTagName ()
	Returns the string to be used for the dependee tag.
static const std::string &	getDependentTagName ()
	Returns the string to be used for the dependent tag.
static const std::string &	getParameterIdAttributeName ()
	Returns the string to be used for the ParameterID attribute.
static const std::string &	getTypeAttributeName ()
	Returns the string to be used for the type attribute.

Detailed Description

An abstract base class for converting Dependencies to and from XML.

Definition at line 63 of file Teuchos_DependencyXMLConverter.hpp.

Member Function Documentation

RCP< Dependency > Teuchos::DependencyXMLConverter::fromXMLtoDependency	(	const XMLObject &	xmlObj,
		const XMLParameterListReader::EntryIDsMap &	entryIDsMap,
		const IDtoValidatorMap &	validatorIDsMap
	)		const

Converts a given XMLObject to a Dependency.

Parameters:

xmlObj	The XMLObject to convert to a Dependency.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.
validtorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:: The converted Dependency.

Definition at line 50 of file Teuchos_DependencyXMLConverter.cpp.

virtual RCP<Dependency> Teuchos::DependencyXMLConverter::convertXML	(	const XMLObject &	xmlObj,
		const Dependency::ConstParameterEntryList	dependees,
		const Dependency::ParameterEntryList	dependets,
		const XMLParameterListReader::EntryIDsMap &	entryIDsMap,
		const IDtoValidatorMap &	validatorIDsMap
	)		const `[pure virtual]`

Preforms any and all special xml conversion that is specific to a particular Dependency.

Parameters:

xmlObj	The xml to be converted. in which this resulting dependency will be inserted.
dependees	The dependees of the dependency.
dependents	The dependents of the dependency.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.
validtorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:: The converted Dependency.

Implemented in Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::VisualDependencyXMLConverter.

XMLObject Teuchos::DependencyXMLConverter::fromDependencytoXML	(	const RCP< const Dependency >	dependency,
		const XMLParameterListWriter::EntryIDsMap &	entryIDsMap,
		ValidatortoIDMap &	validatorIDsMap
	)		const

Converters a given ParameterEntryValidator to XML.

Parameters:

dependency	The Dependency to be converted to XML.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.
validtorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:: An XML representation of the given Dependency.

Definition at line 99 of file Teuchos_DependencyXMLConverter.cpp.

virtual void Teuchos::DependencyXMLConverter::convertDependency	(	const RCP< const Dependency >	dependency,
		XMLObject &	xmlObj,
		const XMLParameterListWriter::EntryIDsMap &	entryIDsMap,
		ValidatortoIDMap &	validatorIDsMap
	)		const `[pure virtual]`

Preforms any and all special dependency conversion that is specific to a particlar Dependency.

Parameters:

dependency	The validator to be converted.
xmlObj	The XMLObject on which all child tags should be appended and attributes added.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.
validtorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:: An XML representation of the given Dependency.

Implemented in Teuchos::ArrayModifierDependencyXMLConverter< DependeeType, DependentType >, Teuchos::ValidatorDependencyXMLConverter, and Teuchos::VisualDependencyXMLConverter.

static const std::string& Teuchos::DependencyXMLConverter::getDependeeTagName ( ) [inline, static]

Returns the string to be used for the dependee tag.

Definition at line 144 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getDependentTagName ( ) [inline, static]

Returns the string to be used for the dependent tag.

Definition at line 152 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getParameterIdAttributeName ( ) [inline, static]

Returns the string to be used for the ParameterID attribute.

Definition at line 160 of file Teuchos_DependencyXMLConverter.hpp.

static const std::string& Teuchos::DependencyXMLConverter::getTypeAttributeName ( ) [inline, static]

Returns the string to be used for the type attribute.

Definition at line 168 of file Teuchos_DependencyXMLConverter.hpp.

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

Converter Functions

Attribute/Query Functions

Detailed Description

Member Function Documentation