Teuchos::StringToIntegralValidatorXMLConverter< IntegralType > Class Template Reference

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

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >:

List of all members.

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
Private Members
static const std::string &	getIntegralValueAttributeName ()
static const std::string &	getStringTagName ()
static const std::string &	getStringValueAttributeName ()
static const std::string &	getStringDocAttributeName ()
static const std::string &	getDefaultParameterAttributeName ()
	Name (tag) of the default parameter attribute.
static const std::string &	getCaseSensitiveAttributeName ()
	Name (tag) of the caseSensitive attribute.

---

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]

Implements Teuchos::ValidatorXMLConverter.

Definition at line 185 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 231 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getIntegralValueAttributeName

(

)

[inline, static, private]

Definition at line 136 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringTagName

(

)

[inline, static, private]

Definition at line 142 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringValueAttributeName

(

)

[inline, static, private]

Definition at line 148 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringDocAttributeName

(

)

[inline, static, private]

Definition at line 154 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getDefaultParameterAttributeName

(

)

[inline, static, private]

Name (tag) of the default parameter attribute.

Definition at line 160 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >

static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getCaseSensitiveAttributeName

(

)

[inline, static, private]

Name (tag) of the caseSensitive attribute.

Definition at line 167 of file Teuchos_StandardValidatorXMLConverters.hpp.

---

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

• Teuchos_StandardValidatorXMLConverters.hpp