Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::ArrayValidatorXMLConverter< ValidatorType, EntryType > Class Template Reference

Converts ArrayValidators to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inherits Teuchos::AbstractArrayValidatorXMLConverter< ValidatorType, EntryType >.

Additional Inherited Members

- Public Member Functions inherited from Teuchos::AbstractArrayValidatorXMLConverter< ValidatorType, EntryType >
RCP< ParameterEntryValidatorconvertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 
void convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const
 
virtual RCP
< AbstractArrayValidator
< ValidatorType, EntryType > > 
getConcreteValidator (RCP< ValidatorType > prototypeValidator) const =0
 Returns a concrete validator that has AbstractArrayValidator as it's parent class. More...
 
- Public Member Functions inherited from Teuchos::ValidatorXMLConverter
RCP< ParameterEntryValidatorfromXMLtoValidator (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a ParameterEntryValidator. More...
 
virtual RCP
< ParameterEntryValidator
convertXML (const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const =0
 Preforms any and all special xml conversion that is specific to a particular ParameterEntryValidator. More...
 
XMLObject fromValidatortoXML (const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
 Converters a given ParameterEntryValidator to XML. More...
 
virtual void convertValidator (const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const =0
 Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValidator. 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 ValidatorType, class EntryType>
class Teuchos::ArrayValidatorXMLConverter< ValidatorType, EntryType >

Converts ArrayValidators to and from XML.

ArrayValidators can be represented in XML one of two ways. The first just creates the prototype validator as a child of the ArrayValidator. In this case, the prototype validator does NOT use a validatorId.

<Validator
type="ArrayValidator(PrototypeValidatorType,ParameterArrayType)"
validatorId="Validator id"
>
...Prototype Validator Goes Here...
</Validator>

The second way to define an ArrayValidator in XML is to just use the "prototypeId" attribute to specify the prototype validator as some other validator you've already defined.

<Validator
type="ArrayValidator(PrototypeValidatorType,ParameterArrayType)"
validatorId="Validator id"
prototypeId="Prototype Validator Id"
/>

Definition at line 716 of file Teuchos_StandardValidatorXMLConverters.hpp.


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