Teuchos::RangeValidatorDependencyXMLConverter< T > Class Template Reference

An xml converter for RangeValidatorDependencies. More...

#include <Teuchos_StandardDependencyXMLConverters.hpp>

Inheritance diagram for Teuchos::RangeValidatorDependencyXMLConverter< T >:

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

Additional Inherited Members
Public Member Functions inherited from Teuchos::ValidatorDependencyXMLConverter
RCP< Dependency >	convertXML (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< Dependency >	fromXMLtoDependency (const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
	Converts a given XMLObject to a Dependency.
XMLObject	fromDependencytoXML (const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) 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::DependencyXMLConverter
static const std::string &	getDependeeTagName ()
	Returns the string to be used for the dependee tag.
static const std::string &	getDependentTagName ()
	Returns the string to be used for the dependent tag.
static const std::string &	getParameterIdAttributeName ()
	Returns the string to be used for the ParameterID attribute.
static const std::string &	getTypeAttributeName ()
	Returns the string to be used for the type attribute.
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the verbLevel argument of describe().
Related Symbols inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator.
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator.

Detailed Description

template<class T>
class Teuchos::RangeValidatorDependencyXMLConverter< T >

An xml converter for RangeValidatorDependencies.

The valid XML representation of a RangeValidatorDependency is:

<Dependency type="RangeValidatorDependency(number_type_of_dependee)"
  defaultValidatoId="id of default validator"
/>
  <Dependee parameterId="Id of dependee parameter"/>
  <Dependent parameterId="Id of dependent parameter"/>
  ...Any other dependent parameters...
  <RangesAndValidators>
    <Pair min="min value" max="max value"
      validatorId="Id of first mapped validator"/>
    <Pair min="min value" max="max value"
      validatorId="Id of second mapped validator"/>
    ...Other range-to-validator mappings...
  </RangesAndValidators>
  ...Optional function tag...
</Dependency>

The "defaultValidatorId" XML attribute is optional.

Definition at line 570 of file Teuchos_StandardDependencyXMLConverters.hpp.

Member Function Documentation

convertSpecialValidatorAttributes() [1/2]

template<class T >

void Teuchos::RangeValidatorDependencyXMLConverter< T >::convertSpecialValidatorAttributes ( RCP< const ValidatorDependency >  dependency, XMLObject &  xmlObj, ValidatortoIDMap &  validatorIDsMap  ) const

virtual

Implements Teuchos::ValidatorDependencyXMLConverter.

Definition at line 642 of file Teuchos_StandardDependencyXMLConverters.hpp.

convertSpecialValidatorAttributes() [2/2]

template<class T >

RCP< ValidatorDependency > Teuchos::RangeValidatorDependencyXMLConverter< T >::convertSpecialValidatorAttributes ( const XMLObject &  xmlObj, RCP< const ParameterEntry >  dependee, const Dependency::ParameterEntryList  dependents, const IDtoValidatorMap &  validatorIDsMap  ) const

virtual

Implements Teuchos::ValidatorDependencyXMLConverter.

Definition at line 687 of file Teuchos_StandardDependencyXMLConverters.hpp.

getRangesAndValidatorsTag()

template<class T >

static const std::string & Teuchos::RangeValidatorDependencyXMLConverter< T >::getRangesAndValidatorsTag ( )

inlinestatic

Definition at line 592 of file Teuchos_StandardDependencyXMLConverters.hpp.

---

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

• Teuchos_StandardDependencyXMLConverters.hpp