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::ValidatorDependencyXMLConverter Class Referenceabstract

An xml converter for ValidatorDependencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::ValidatorDependencyXMLConverter:
Teuchos::DependencyXMLConverter Teuchos::Describable Teuchos::LabeledObject Teuchos::BoolValidatorDependencyXMLConverter Teuchos::RangeValidatorDependencyXMLConverter< T > Teuchos::StringValidatorDependencyXMLConverter

Public Member Functions

Special converter methods
virtual void convertSpecialValidatorAttributes (RCP< const ValidatorDependency > dependency, XMLObject &xmlObj, ValidatortoIDMap &validatorIDsMap) const =0
 Converts any special aspects of a specific validator dependency to xml. More...
 
virtual RCP< ValidatorDependencyconvertSpecialValidatorAttributes (const XMLObject &xmlObj, RCP< const ParameterEntry > dependee, const Dependency::ParameterEntryList dependents, const IDtoValidatorMap &validatorIDsMap) const =0
 Converts any special aspects of a specific validator dependency from xml. More...
 
Overridden from DependencyXMLConverter
RCP< DependencyconvertXML (const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 
void convertDependency (const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
 
- Public Member Functions inherited from Teuchos::DependencyXMLConverter
RCP< DependencyfromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
 Converts a given XMLObject to a Dependency. More...
 
XMLObject fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Teuchos::DependencyXMLConverter
static const std::string & getDependeeTagName ()
 Returns the string to be used for the dependee tag. More...
 
static const std::string & getDependentTagName ()
 Returns the string to be used for the dependent tag. More...
 
static const std::string & getParameterIdAttributeName ()
 Returns the string to be used for the ParameterID attribute. More...
 
static const std::string & getTypeAttributeName ()
 Returns the string to be used for the type attribute. More...
 
- 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

An xml converter for ValidatorDependencies.

Definition at line 108 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

virtual void Teuchos::ValidatorDependencyXMLConverter::convertSpecialValidatorAttributes ( RCP< const ValidatorDependency dependency,
XMLObject xmlObj,
ValidatortoIDMap validatorIDsMap 
) const
pure virtual

Converts any special aspects of a specific validator dependency to xml.

Parameters
dependencyThe dependency being converted.
xmlObjThe XMLObject to which the dependency is being converted.
validatorIDsMapA map containing validators and their associated IDs.
Returns
An XMLObject representing the ValidatorDepenency.

Implemented in Teuchos::RangeValidatorDependencyXMLConverter< T >, Teuchos::BoolValidatorDependencyXMLConverter, and Teuchos::StringValidatorDependencyXMLConverter.

virtual RCP<ValidatorDependency> Teuchos::ValidatorDependencyXMLConverter::convertSpecialValidatorAttributes ( const XMLObject xmlObj,
RCP< const ParameterEntry dependee,
const Dependency::ParameterEntryList  dependents,
const IDtoValidatorMap validatorIDsMap 
) const
pure virtual

Converts any special aspects of a specific validator dependency from xml.

Parameters
xmlObjThe xml being converted.
dependeeThe dependees of the validator dependency.
dependentsThe dependents of the validator dependency.
validatorIDsMapA map containing validators and their associated IDs.
Returns
The converted ValidatorDependency.

Implemented in Teuchos::RangeValidatorDependencyXMLConverter< T >, Teuchos::BoolValidatorDependencyXMLConverter, and Teuchos::StringValidatorDependencyXMLConverter.

RCP< Dependency > Teuchos::ValidatorDependencyXMLConverter::convertXML ( const XMLObject xmlObj,
const Dependency::ConstParameterEntryList  dependees,
const Dependency::ParameterEntryList  dependets,
const XMLParameterListReader::EntryIDsMap entryIDsMap,
const IDtoValidatorMap validatorIDsMap 
) const
virtual
void Teuchos::ValidatorDependencyXMLConverter::convertDependency ( const RCP< const Dependency dependency,
XMLObject xmlObj,
const XMLParameterListWriter::EntryIDsMap entryIDsMap,
ValidatortoIDMap validatorIDsMap 
) const
virtual

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