Teuchos - Trilinos Tools Package Version of the Day
Teuchos::ValidatorXMLConverterDB Class Reference

Provides ability to lookup ValidatorXMLConverterDB. More...

#include <Teuchos_ValidatorXMLConverterDB.hpp>

List of all members.

Static Public Member Functions

Modifier Functions
static void addConverter (RCP< const ParameterEntryValidator > validator, RCP< ValidatorXMLConverter > converterToAdd)
 Add a converter to the database.
Converter Functions
static RCP< const
ValidatorXMLConverter
getConverter (const ParameterEntryValidator &validator)
 Get an appropriate ValidatorXMLConverter given a Validator.
static RCP< const
ValidatorXMLConverter
getConverter (const XMLObject &xmlObject)
 Get an appropriate ValidatorXMLConverter given a XMLObject.
static XMLObject convertValidator (RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true)
 Given a validator converts the validator to XML.
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.
I/O Functions
static void printKnownConverters (std::ostream &out)
 prints the xml tags associated with all known converters

Detailed Description

Provides ability to lookup ValidatorXMLConverterDB.

Definition at line 59 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:
validatorA dummy validator representing the type of validator the converter is designed to convert.
convertToAddThe converter to add to the database.

Definition at line 52 of file Teuchos_ValidatorXMLConverterDB.cpp.

RCP< const ValidatorXMLConverter > Teuchos::ValidatorXMLConverterDB::getConverter ( const ParameterEntryValidator validator) [static]

Get an appropriate ValidatorXMLConverter given a Validator.

Parameters:
validatorThe ParameterEntryValidator for which a converter is desired.

Definition at line 61 of file Teuchos_ValidatorXMLConverterDB.cpp.

RCP< const ValidatorXMLConverter > Teuchos::ValidatorXMLConverterDB::getConverter ( const XMLObject xmlObject) [static]

Get an appropriate ValidatorXMLConverter given a XMLObject.

Parameters:
xmlObjectThe XMLObject for which a converter is desired.

Definition at line 76 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:
validatorThe validator to be converter.
validatorIDsMapA map containing ParameterEntryValidators and their associated IDs.
assignedIDWhether 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 92 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:
xmlObjectThe XMLObject representing the validator to be converted.
validatorIDsMapA map containing ParameterEntryValidators and their associated IDs.
Returns:
A ParameterEntryValidator that was represented by the XML.

Definition at line 102 of file Teuchos_ValidatorXMLConverterDB.cpp.

void Teuchos::ValidatorXMLConverterDB::printKnownConverters ( std::ostream &  out) [static]

prints the xml tags associated with all known converters

Parameters:
outStream to which tags should be printed.

Definition at line 120 of file Teuchos_ValidatorXMLConverterDB.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines