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::StringToIntegralValidatorXMLConverter< IntegralType > Class Template Reference

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

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >:
Inheritance graph
[legend]

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
 

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. More...
 
static const std::string & getCaseSensitiveAttributeName ()
 Name (tag) of the caseSensitive attribute. More...
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::ValidatorXMLConverter
RCP< ParameterEntryValidatorfromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a ParameterEntryValidator. More...
 
XMLObject fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
 Converters a given ParameterEntryValidator to XML. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 
- Static Public Member Functions inherited from Teuchos::ValidatorXMLConverter
static const std::string & getIdAttributeName ()
 
static const std::string & getPrototypeIdAttributeName ()
 
static const std::string & getTypeAttributeName ()
 
static const std::string & getValidatorTagName ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

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
template<class IntegralType >
static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getIntegralValueAttributeName ( )
inlinestaticprivate

Definition at line 136 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >
static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringTagName ( )
inlinestaticprivate

Definition at line 142 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >
static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringValueAttributeName ( )
inlinestaticprivate

Definition at line 148 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >
static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getStringDocAttributeName ( )
inlinestaticprivate

Definition at line 154 of file Teuchos_StandardValidatorXMLConverters.hpp.

template<class IntegralType >
static const std::string& Teuchos::StringToIntegralValidatorXMLConverter< IntegralType >::getDefaultParameterAttributeName ( )
inlinestaticprivate

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

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: