Teuchos - Trilinos Tools Package Version of the Day
|
A RangeValidatorDependency says the following about the relationship between two parameters: Dependening on the value of the dependee, the dependent should use a particular validator from a given set of validators. More...
#include <Teuchos_StandardDependencies.hpp>
Public Types | |
Public types | |
typedef std::pair< T, T > | Range |
Convenience typedef. | |
typedef std::map< Range, RCP< const ParameterEntryValidator > > | RangeToValidatorMap |
Convenience typedef. | |
typedef std::pair< Range, RCP< const ParameterEntryValidator > > | RangeValidatorPair |
Convenience typedef. | |
![]() | |
typedef std::set< RCP< ParameterEntry >, RCPComp > | ParameterEntryList |
A list of Dependees. | |
typedef std::set< RCP< const ParameterEntry >, RCPConstComp > | ConstParameterEntryList |
A list of dependents. | |
Overridden from Dependency | |
void | evaluate () |
std::string | getTypeAttributeValue () const |
void | validateDep () const |
Additional Inherited Members | |
![]() | |
static const std::string & | getXMLTagName () |
Returns the XML tag to use when serializing Dependencies. | |
![]() | |
static const EVerbosityLevel | verbLevel_default = VERB_DEFAULT |
Default value for the verbLevel argument of describe(). | |
Validation Functions | |
![]() | |
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. | |
A RangeValidatorDependency says the following about the relationship between two parameters: Dependening on the value of the dependee, the dependent should use a particular validator from a given set of validators.
A RangeValidatorDependency achieves this by associating ranges of values with validators. If the dependees value falls within the one of the ranges, the validator associated with the range is used on the dependent. If the value doesn't fall within any of the ranges, the dependent's validator is set to the specified default validator. If no default validator was specified, then the dependents validator is set to null.
The minimum of ranges is inclusive and the maximum is exclusive.
A RangeValidatorDependency must have the following characterisitics:
Please see RangeValidatorDependencyXMLConverter for documentation regarding the XML representation of this Dependency.
Definition at line 1548 of file Teuchos_StandardDependencies.hpp.
Convenience typedef.
Definition at line 1558 of file Teuchos_StandardDependencies.hpp.
typedef std::map<Range, RCP<const ParameterEntryValidator> > Teuchos::RangeValidatorDependency< T >::RangeToValidatorMap |
Convenience typedef.
Definition at line 1564 of file Teuchos_StandardDependencies.hpp.
typedef std::pair<Range, RCP<const ParameterEntryValidator> > Teuchos::RangeValidatorDependency< T >::RangeValidatorPair |
Convenience typedef.
Definition at line 1570 of file Teuchos_StandardDependencies.hpp.
Teuchos::RangeValidatorDependency< T >::RangeValidatorDependency | ( | RCP< const ParameterEntry > | dependee, |
RCP< ParameterEntry > | dependent, | ||
RangeToValidatorMap | rangesAndValidators, | ||
RCP< const ParameterEntryValidator > | defaultValidator = null ) |
Constructs a RangeValidatorDependency.
dependee | The dependee parameter. |
dependent | The dependent parameter. |
rangesAndValidators | A map associating ranges of values with ParameterEntryValidators. This will be used to deteremine what type of validator should be applied to the dependent based on the dependees value. |
defaultValidator | The default validator to be used if the dependee's value does not fall within one of the specified ranges. |
Definition at line 1678 of file Teuchos_StandardDependencies.hpp.
Teuchos::RangeValidatorDependency< T >::RangeValidatorDependency | ( | RCP< const ParameterEntry > | dependee, |
Dependency::ParameterEntryList | dependents, | ||
RangeToValidatorMap | rangesAndValidators, | ||
RCP< const ParameterEntryValidator > | defaultValidator = null ) |
Constructs a RangeValidatorDependency.
dependee | The dependee parameter. |
dependents | The dependents. |
rangesAndValidators | A map associating ranges of values with ParameterEntryValidators. This will be used to deteremine what type of validator should be applied to the dependent based on the dependees value. |
defaultValidator | The default validator to be used if the dependee's value does not fall within one of the specified ranges. |
Definition at line 1691 of file Teuchos_StandardDependencies.hpp.
|
inline |
Definition at line 1621 of file Teuchos_StandardDependencies.hpp.
|
inline |
Definition at line 1626 of file Teuchos_StandardDependencies.hpp.
|
virtual |
Implements Teuchos::ValidatorDependency.
Definition at line 1711 of file Teuchos_StandardDependencies.hpp.
|
virtual |
Implements Teuchos::Dependency.
Definition at line 1704 of file Teuchos_StandardDependencies.hpp.
|
protectedvirtual |
Implements Teuchos::Dependency.
Definition at line 1730 of file Teuchos_StandardDependencies.hpp.