An xml converter for VisualDepenencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::VisualDependencyXMLConverter:

Special converter methods
virtual void	convertSpecialVisualAttributes (RCP< const VisualDependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const =0
	Converts any special aspects of a specific visual dependency to xml. More...

virtual RCP< VisualDependency >	convertSpecialVisualAttributes (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, bool showIf, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const =0
	Converts any special aspects of a specific visual dependency from xml. More...

Overridden from DependencyXMLConverter
RCP< Dependency >	convertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const

void	convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const

Private Members
static const std::string &	getShowIfAttributeName ()
	Gets the name of the showif attribute. More...

Additional Inherited Members
Public Member Functions inherited from Teuchos::DependencyXMLConverter
RCP< Dependency >	fromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
	Converts a given XMLObject to a Dependency. More...

XMLObject	fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
	Converters a given ParameterEntryValidator to XML. More...

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object. More...

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream. More...

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream. More...

virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes). More...

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label. More...

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject). More...

virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject). More...

Static Public Member Functions inherited from Teuchos::DependencyXMLConverter
static const std::string &	getDependeeTagName ()
	Returns the string to be used for the dependee tag. More...

static const std::string &	getDependentTagName ()
	Returns the string to be used for the dependent tag. More...

static const std::string &	getParameterIdAttributeName ()
	Returns the string to be used for the ParameterID attribute. More...

static const std::string &	getTypeAttributeName ()
	Returns the string to be used for the type attribute. More...

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe(). More...

Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

Detailed Description

An xml converter for VisualDepenencies.

Definition at line 29 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

virtual void Teuchos::VisualDependencyXMLConverter::convertSpecialVisualAttributes	(	RCP< const VisualDependency >	dependency,
		XMLObject &	xmlObj,
		const XMLParameterListWriter::EntryIDsMap &	entryIDsMap
	)		const

pure virtual

Converts any special aspects of a specific visual dependency to xml.

Parameters

dependency	The dependency being converted.
xmlObj	The XMLObject to which the dependency is being converted.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.

Returns: An XMLObject representing the VisualDependency.

Implemented in Teuchos::ConditionVisualDependencyXMLConverter, Teuchos::NumberVisualDependencyXMLConverter< T >, Teuchos::BoolVisualDependencyXMLConverter, and Teuchos::StringVisualDependencyXMLConverter.

virtual RCP<VisualDependency> Teuchos::VisualDependencyXMLConverter::convertSpecialVisualAttributes	(	const XMLObject &	xmlObj,
		const Dependency::ConstParameterEntryList	dependees,
		const Dependency::ParameterEntryList	dependets,
		bool	showIf,
		const XMLParameterListReader::EntryIDsMap &	entryIDsMap
	)		const

pure virtual

Converts any special aspects of a specific visual dependency from xml.

Parameters

xmlObj	The xml being converted.
dependees	The dependees of the visual dependency.
dependents	The dependents of the visua dependency.
showIf	The showIf attribute of the visual dependency.
entryIDsMap	A map containing ParameterEntrys and their associated IDs.

Returns: The converted VisualDependency.

Implemented in Teuchos::ConditionVisualDependencyXMLConverter, Teuchos::NumberVisualDependencyXMLConverter< T >, Teuchos::BoolVisualDependencyXMLConverter, and Teuchos::StringVisualDependencyXMLConverter.

RCP< Dependency > Teuchos::VisualDependencyXMLConverter::convertXML	(	const XMLObject &	xmlObj,
		const Dependency::ConstParameterEntryList	dependees,
		const Dependency::ParameterEntryList	dependets,
		const XMLParameterListReader::EntryIDsMap &	entryIDsMap,
		const IDtoValidatorMap &	validatorIDsMap
	)		const

virtual

Implements Teuchos::DependencyXMLConverter.

Definition at line 17 of file Teuchos_StandardDependencyXMLConverters.cpp.

void Teuchos::VisualDependencyXMLConverter::convertDependency	(	const RCP< const Dependency >	dependency,
		XMLObject &	xmlObj,
		const XMLParameterListWriter::EntryIDsMap &	entryIDsMap,
		ValidatortoIDMap &	validatorIDsMap
	)		const

virtual

Implements Teuchos::DependencyXMLConverter.

Definition at line 34 of file Teuchos_StandardDependencyXMLConverters.cpp.

static const std::string& Teuchos::VisualDependencyXMLConverter::getShowIfAttributeName ( )

inlinestaticprivate

Gets the name of the showif attribute.

Definition at line 97 of file Teuchos_StandardDependencyXMLConverters.hpp.

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

Special converter methods

Overridden from DependencyXMLConverter

Private Members

Additional Inherited Members

Detailed Description

Member Function Documentation