Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::TwoDArrayValidatorXMLConverter< ValidatorType, EntryType > Class Template Reference

Converts TwoDArrayValidators to and from XML. More...

#include <Teuchos_StandardValidatorXMLConverters.hpp>

Inheritance diagram for Teuchos::TwoDArrayValidatorXMLConverter< ValidatorType, EntryType >:
Inheritance graph
[legend]

Overridden from AbstractArrayValidatorXMLConverter

virtual RCP< AbstractArrayValidator< ValidatorType, EntryType > > getConcreteValidator (RCP< ValidatorType > prototypeValidator) const
 Returns a concrete validator that has AbstractArrayValidator as it's parent class.
 

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

Detailed Description

template<class ValidatorType, class EntryType>
class Teuchos::TwoDArrayValidatorXMLConverter< ValidatorType, EntryType >

Converts TwoDArrayValidators to and from XML.

TwoDArrayValidators 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.

type="TwoDArrayValidator(PrototypeValidatorType,ParameterArrayType)"
validatorId="Validator id"
>
...Prototype Validator Goes Here...
Concrete serial communicator subclass.

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

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

Definition at line 801 of file Teuchos_StandardValidatorXMLConverters.hpp.

Member Function Documentation

◆ getConcreteValidator()

template<class ValidatorType , class EntryType >
virtual RCP< AbstractArrayValidator< ValidatorType, EntryType > > Teuchos::TwoDArrayValidatorXMLConverter< ValidatorType, EntryType >::getConcreteValidator ( RCP< ValidatorType > prototypeValidator) const
inlineprivatevirtual

Returns a concrete validator that has AbstractArrayValidator as it's parent class.

Implements Teuchos::AbstractArrayValidatorXMLConverter< ValidatorType, EntryType >.

Definition at line 807 of file Teuchos_StandardValidatorXMLConverters.hpp.


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