Teuchos::StringToIntegralValidatorXMLConverter< IntegralType > Class Template Reference

Converts StringToIntegralParameterEntryValidators to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >:

List of all members.

Public Member Functions
Overridden from ValidatorXMLConverter
RCP< ParameterEntryValidator >	convertXML (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 >

Converts StringToIntegralParameterEntryValidators to and from XML.

The XML Representation for a StringToIntegralValidator is:

  <Validator 
    type="StringToIntegralValidator(NumberType)"
    defaultParameterName="Name of default parameter"
    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>

The "integralValue" and "stringDoc" 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 89 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]

Implements Teuchos::ValidatorXMLConverter.

Definition at line 168 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

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

Implements Teuchos::ValidatorXMLConverter.

Definition at line 212 of file Teuchos_StandardValidatorXMLConverters.hpp.

---

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

• Teuchos_StandardValidatorXMLConverters.hpp