Provides ability to lookup ValidatorXMLConverterDB. More...

#include <Teuchos_ValidatorXMLConverterDB.hpp>

Modifier Functions
static void	addConverter (RCP< const ParameterEntryValidator > validator, RCP< ValidatorXMLConverter > converterToAdd)
	Add a converter to the database. More...

Converter Functions
static RCP< const ValidatorXMLConverter >	getConverter (const ParameterEntryValidator &validator)
	Get an appropriate ValidatorXMLConverter given a Validator. More...

static RCP< const ValidatorXMLConverter >	getConverter (const XMLObject &xmlObject)
	Get an appropriate ValidatorXMLConverter given a XMLObject. More...

static XMLObject	convertValidator (RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true)
	Given a validator converts the validator to XML. More...

static RCP < ParameterEntryValidator >	convertXML (const XMLObject &xmlObject, const IDtoValidatorMap &validatorIDsMap)
	Given an XMLObject converts the XMLObject to a ParameterEntryValidator and inserts the validator into the map. More...

I/O Functions
static void	printKnownConverters (std::ostream &out)
	prints the xml tags associated with all known converters More...

Private types.
typedef std::map< std::string, RCP< ValidatorXMLConverter > >	ConverterMap
	convience class. More...

typedef std::pair< std::string, RCP< ValidatorXMLConverter > >	ConverterPair
	convience typedef. More...

Setup functions
static ConverterMap &	getConverterMap ()
	Gets the default converter to be used to convert Validators. More...

Detailed Description

Provides ability to lookup ValidatorXMLConverterDB.

Definition at line 26 of file Teuchos_ValidatorXMLConverterDB.hpp.

Member Typedef Documentation

typedef std::map<std::string, RCP<ValidatorXMLConverter> > Teuchos::ValidatorXMLConverterDB::ConverterMap

private

convience class.

Definition at line 114 of file Teuchos_ValidatorXMLConverterDB.hpp.

typedef std::pair<std::string, RCP<ValidatorXMLConverter> > Teuchos::ValidatorXMLConverterDB::ConverterPair

private

convience typedef.

Definition at line 117 of file Teuchos_ValidatorXMLConverterDB.hpp.

Member Function Documentation

void Teuchos::ValidatorXMLConverterDB::addConverter	(	RCP< const ParameterEntryValidator >	validator,
		RCP< ValidatorXMLConverter >	converterToAdd
	)

static

Add a converter to the database.

Parameters

validator	A dummy validator representing the type of validator the converter is designed to convert.
convertToAdd	The converter to add to the database.

Definition at line 20 of file Teuchos_ValidatorXMLConverterDB.cpp.

RCP< const ValidatorXMLConverter > Teuchos::ValidatorXMLConverterDB::getConverter ( const ParameterEntryValidator & validator )

static

Get an appropriate ValidatorXMLConverter given a Validator.

Parameters

validator The ParameterEntryValidator for which a converter is desired.

Definition at line 29 of file Teuchos_ValidatorXMLConverterDB.cpp.

RCP< const ValidatorXMLConverter > Teuchos::ValidatorXMLConverterDB::getConverter ( const XMLObject & xmlObject )

static

Get an appropriate ValidatorXMLConverter given a XMLObject.

Parameters

xmlObject The XMLObject for which a converter is desired.

Definition at line 44 of file Teuchos_ValidatorXMLConverterDB.cpp.

XMLObject Teuchos::ValidatorXMLConverterDB::convertValidator	(	RCP< const ParameterEntryValidator >	validator,
		const ValidatortoIDMap &	validatorIDsMap,
		bool	assignedID = `true`
	)

static

Given a validator converts the validator to XML.

Parameters

validator	The validator to be converter.
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: XML representation of the validator.

Definition at line 60 of file Teuchos_ValidatorXMLConverterDB.cpp.

RCP< ParameterEntryValidator > Teuchos::ValidatorXMLConverterDB::convertXML	(	const XMLObject &	xmlObject,
		const IDtoValidatorMap &	validatorIDsMap
	)

static

Given an XMLObject converts the XMLObject to a ParameterEntryValidator and inserts the validator into the map.

Parameters

xmlObject	The XMLObject representing the validator to be converted.
validatorIDsMap	A map containing ParameterEntryValidators and their associated IDs.

Returns: A ParameterEntryValidator that was represented by the XML.

Definition at line 70 of file Teuchos_ValidatorXMLConverterDB.cpp.

void Teuchos::ValidatorXMLConverterDB::printKnownConverters ( std::ostream & out )

static

prints the xml tags associated with all known converters

Parameters

out	Stream to which tags should be printed.

Definition at line 88 of file Teuchos_ValidatorXMLConverterDB.cpp.

ValidatorXMLConverterDB::ConverterMap & Teuchos::ValidatorXMLConverterDB::getConverterMap ( )

staticprivate

Gets the default converter to be used to convert Validators.

This map is used to enable outside code to set up new converter types.

Definition at line 80 of file Teuchos_ValidatorXMLConverterDB.cpp.

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

Modifier Functions

Converter Functions

I/O Functions

Private types.

Setup functions

Detailed Description

Member Typedef Documentation

Member Function Documentation