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::StringValidatorDependencyXMLConverter Class Reference

An xml converter for StringValidatorDependencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::StringValidatorDependencyXMLConverter:
Inheritance graph
[legend]

Overridden from ValidatorDependencyConverter

void convertSpecialValidatorAttributes (RCP< const ValidatorDependency > dependency, XMLObject &xmlObj, ValidatortoIDMap &validatorIDsMap) const
 
RCP< ValidatorDependencyconvertSpecialValidatorAttributes (const XMLObject &xmlObj, RCP< const ParameterEntry > dependee, const Dependency::ParameterEntryList dependents, const IDtoValidatorMap &validatorIDsMap) const
 
static const std::string & getValuesAndValidatorsTag ()
 

Private Members

static const std::string & getPairTag ()
 
static const std::string & getValueAttributeName ()
 
static const std::string & getValidatorIdAttributeName ()
 
static const std::string & getDefaultValidatorIdAttributeName ()
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::ValidatorDependencyXMLConverter
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...
 
- 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 StringValidatorDependencies.

The valid XML representation of a StringValidatorDependency is:

<Dependency type="StringValidatorDependency"
defaultValidatorId="value of default validator"
/>
<Dependee parameterId="Id of dependee parameter"/>
<Dependent parameterId="Id of dependent parameter"/>
...Additional Dependents...
<ValuesAndValidators>
<Pair value="Value 1" validatorId="Id of first mapped validator"/>
<Pair value="Value 2" validatorId="Id of second mapped validator"/>
...Other value-to-validator mappings
</ValuesAndValidators>
</Dependency>

The "defaultValidatorId" XML attribute is optional.

Definition at line 456 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

void Teuchos::StringValidatorDependencyXMLConverter::convertSpecialValidatorAttributes ( RCP< const ValidatorDependency dependency,
XMLObject xmlObj,
ValidatortoIDMap validatorIDsMap 
) const
virtual
RCP< ValidatorDependency > Teuchos::StringValidatorDependencyXMLConverter::convertSpecialValidatorAttributes ( const XMLObject xmlObj,
RCP< const ParameterEntry dependee,
const Dependency::ParameterEntryList  dependents,
const IDtoValidatorMap validatorIDsMap 
) const
virtual
static const std::string& Teuchos::StringValidatorDependencyXMLConverter::getValuesAndValidatorsTag ( )
inlinestatic

Definition at line 478 of file Teuchos_StandardDependencyXMLConverters.hpp.

static const std::string& Teuchos::StringValidatorDependencyXMLConverter::getPairTag ( )
inlinestaticprivate

Definition at line 490 of file Teuchos_StandardDependencyXMLConverters.hpp.

static const std::string& Teuchos::StringValidatorDependencyXMLConverter::getValueAttributeName ( )
inlinestaticprivate

Definition at line 496 of file Teuchos_StandardDependencyXMLConverters.hpp.

static const std::string& Teuchos::StringValidatorDependencyXMLConverter::getValidatorIdAttributeName ( )
inlinestaticprivate

Definition at line 502 of file Teuchos_StandardDependencyXMLConverters.hpp.

static const std::string& Teuchos::StringValidatorDependencyXMLConverter::getDefaultValidatorIdAttributeName ( )
inlinestaticprivate

Definition at line 508 of file Teuchos_StandardDependencyXMLConverters.hpp.


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