Teuchos - Trilinos Tools Package Version of the Day
Teuchos::StringToIntegralValidatorXMLConverter< IntegralType > Class Template Reference

Convert a StringToIntegralParameterEntryValidator to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >:
Teuchos::ValidatorXMLConverter Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

Overridden from ValidatorXMLConverter
RCP< ParameterEntryValidatorconvertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 
void convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const
 

Detailed Description

template<class IntegralType>
class Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >

Convert a StringToIntegralParameterEntryValidator to and from XML.

This class knows how to write a StringToIntegralParameterEntryValidator to XML, and create an StringToIntegralParameterEntryValidator from its XML representation.

Here is the XML representation of a StringToIntegralValidator:

 <Validator
   type="StringToIntegralValidator(NumberType)"
   defaultParameterName="Name of default parameter"
   caseSensitive="[true|false]"
   validatorId="Validator id"
 >
   <String
     stringValue="Value 1"
     integralValue="int value 1"
     stringDoc="Documentation for Value 1"
   />
   <String
     stringValue="Value 2"
     integralValue="int value 2"
     stringDoc="Documentation for Value 2"
   />
   ...More String Values...
 </Validator>

Here, "[true|false]" means the XML string representation of either Boolean true, or Boolean false.

The "integralValue", "stringDoc", and "caseSensitive" XML attributes are optional. However, if one of the "String" tags includes an "integralValue" and/or a "stringDoc" XML attribute, all other "String" tags must do so as well.

Definition at line 99 of file Teuchos_StandardValidatorXMLConverters.hpp.


Member Function Documentation

template<class IntegralType >
RCP< ParameterEntryValidator > Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::convertXML ( const XMLObject xmlObj,
const IDtoValidatorMap validatorIDsMap 
) const [virtual]
template<class IntegralType >
void Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::convertValidator ( const RCP< const ParameterEntryValidator validator,
XMLObject xmlObj,
const ValidatortoIDMap validatorIDsMap 
) const [virtual]

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