Teuchos::ValidatorXMLConverter Class Reference

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

#include <Teuchos_ValidatorXMLConverter.hpp>

Inheritance diagram for Teuchos::ValidatorXMLConverter:

List of all members.

Converter Functions
RCP< ParameterEntryValidator >	fromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
	Converts a given XMLObject to a ParameterEntryValidator.
virtual RCP < ParameterEntryValidator >	convertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const =0
	Preforms any and all special xml conversion that is specific to a particular ParameterEntryValidator.
XMLObject	fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
	Converters a given ParameterEntryValidator to XML.
virtual void	convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const =0
	Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValidator.
Attribute/Query Functions
static const std::string &	getIdAttributeName ()
static const std::string &	getPrototypeIdAttributeName ()
static const std::string &	getTypeAttributeName ()
static const std::string &	getValidatorTagName ()

---

Detailed Description

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

Definition at line 64 of file Teuchos_ValidatorXMLConverter.hpp.

---

Member Function Documentation

RCP< ParameterEntryValidator > Teuchos::ValidatorXMLConverter::fromXMLtoValidator	(	const XMLObject &	xmlObj,
		const IDtoValidatorMap &	validatorIDsMap
	)		const

Converts a given XMLObject to a ParameterEntryValidator.

Parameters:

xmlObj	The XMLObject to convert to a ParameterEntryValidator.
validatorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:

The converted ParameterEntryValidator.

Definition at line 47 of file Teuchos_ValidatorXMLConverter.cpp.

virtual RCP<ParameterEntryValidator> Teuchos::ValidatorXMLConverter::convertXML	(	const XMLObject &	xmlObj,
		const IDtoValidatorMap &	validatorIDsMap
	)		const [pure virtual]

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

Parameters:

xmlObj	The xml to be converted.
validatorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns:

The converted ParameterEntryValidator.

Implemented in Teuchos::AbstractArrayValidatorXMLConverter< ValidatorType, EntryType >, Teuchos::StringValidatorXMLConverter, Teuchos::FileNameValidatorXMLConverter, Teuchos::EnhancedNumberValidatorXMLConverter< T >, Teuchos::AnyNumberValidatorXMLConverter, and Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >.

XMLObject Teuchos::ValidatorXMLConverter::fromValidatortoXML	(	const RCP< const ParameterEntryValidator >	validator,
		const ValidatortoIDMap &	validatorIDsMap,
		bool	assignedID = true
	)		const

Converters a given ParameterEntryValidator to XML.

Parameters:

validator	The ParameterEntryValidator to be converted to XML.
validatorIDsMap	A map containing ParameterEntryValidators and their associated IDs.
assignedID	Whether or not the validator to be converted has been assigned an ID and is therefore in the validatorIDsMap and should have a ID attribute.

Returns:

An XML representation of the given ParameterEntryValidator.

Definition at line 68 of file Teuchos_ValidatorXMLConverter.cpp.

virtual void Teuchos::ValidatorXMLConverter::convertValidator	(	const RCP< const ParameterEntryValidator >	validator,
		XMLObject &	xmlObj,
		const ValidatortoIDMap &	validatorIDsMap
	)		const [pure virtual]

Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValidator.

Parameters:

validator	The validator to be converted.
xmlObj	The XMLObject to store all serialization in.
validatorIDsMap	A map containing ParameterEntryValidators and their associated IDs. being converted.

Implemented in Teuchos::AbstractArrayValidatorXMLConverter< ValidatorType, EntryType >, Teuchos::StringValidatorXMLConverter, Teuchos::FileNameValidatorXMLConverter, Teuchos::EnhancedNumberValidatorXMLConverter< T >, Teuchos::AnyNumberValidatorXMLConverter, and Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >.

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

(

)

[inline, static]

Definition at line 147 of file Teuchos_ValidatorXMLConverter.hpp.

static const std::string& Teuchos::ValidatorXMLConverter::getPrototypeIdAttributeName

(

)

[inline, static]

Definition at line 153 of file Teuchos_ValidatorXMLConverter.hpp.

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

(

)

[inline, static]

Definition at line 159 of file Teuchos_ValidatorXMLConverter.hpp.

static const std::string& Teuchos::ValidatorXMLConverter::getValidatorTagName

(

)

[inline, static]

Definition at line 165 of file Teuchos_ValidatorXMLConverter.hpp.

---

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

• Teuchos_ValidatorXMLConverter.hpp
• Teuchos_ValidatorXMLConverter.cpp