Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::ValidatorXMLConverterDB Class Reference

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 ConverterMapgetConverterMap ()
 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

convience class.

Definition at line 114 of file Teuchos_ValidatorXMLConverterDB.hpp.

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
validatorA dummy validator representing the type of validator the converter is designed to convert.
convertToAddThe 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
validatorThe 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
xmlObjectThe 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
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 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
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 70 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 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: