Teuchos - Trilinos Tools Package Version of the Day
Teuchos::NumberVisualDependency< T > Class Template Reference

A number visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee has a certain value, the dependent may or may not be displayed to the user in a UI. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::NumberVisualDependency< T >:
Teuchos::VisualDependency Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

Constructors
 NumberVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=true, RCP< SimpleFunctionObject< T > > func=null)
 Constructs a NumberVisualDependency.
 NumberVisualDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, bool showIf=true, RCP< SimpleFunctionObject< T > > func=null)
 Constructs a NumberVisualDependency.
Overridden from VisualDependency
bool getDependeeState () const
 Get the state of the dependee in order to evaluate the dependency.
Getter Functions
RCP< const
SimpleFunctionObject< T > > 
getFunctionObject () const
 Const version of function getter.

Overridden from Dependency

std::string getTypeAttributeValue () const
 
void validateDep () const
 

Detailed Description

template<class T>
class Teuchos::NumberVisualDependency< T >

A number visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee has a certain value, the dependent may or may not be displayed to the user in a UI.

The dependee of a NumberVisualDependency must be a number type and can't be an array. The dependent may be any type of parameter or parameter list. If no function is provided, then the value of the Dependee is simply compared to 0. If it is greater than 0, the dependency evaluates to true. Otherwise it evaluates to false. If a function is provided, then the value of the Dependee is first ran through that function. The result of that function is then compared to 0 using the same criteria as above.

Please see NumberVisualDependencyXMLConverter for documentation regarding the XML representation of this Dependency.

Definition at line 660 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

template<class T >
Teuchos::NumberVisualDependency< T >::NumberVisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
bool  showIf = true,
RCP< SimpleFunctionObject< T > >  func = null 
)

Constructs a NumberVisualDependency.

Parameters:
dependeeThe dependee parameter.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.
funcA function that takes the dependees value, does some calculations on it, and then returns a value. If this value is greater than 0, the dependent is show. If the value returned is less than or equal to zero, the dependent is not shown. If showIf is set to valse then these visibility results will be reversed. If no fuction is specified, the direct value of the dependee will be used to determine the dependents visibility in a similar fashion (postive numbers causing the dependent to be displayed and 0 or negative numbers causing the dependent to be hidden).

Definition at line 770 of file Teuchos_StandardDependencies.hpp.

template<class T >
Teuchos::NumberVisualDependency< T >::NumberVisualDependency ( RCP< const ParameterEntry dependee,
ParameterEntryList  dependents,
bool  showIf = true,
RCP< SimpleFunctionObject< T > >  func = null 
)

Constructs a NumberVisualDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependents.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.
funcA function that takes the dependees value, does some calculations on it, and then returns a value. If this value is greater than 0, the dependent is show. If the value returned is less than or equal to zero, the dependent is not shown. If showIf is set to false, then these visibility results will be reversed. If no fuction is specified, the direct value of the dependee will be used to determine the dependents visibility in a similar fashion (postive numbers causing the dependent to be displayed and 0 or negative numbers causing the dependent to be hidden).

Definition at line 782 of file Teuchos_StandardDependencies.hpp.


Member Function Documentation

template<class T >
bool Teuchos::NumberVisualDependency< T >::getDependeeState ( ) const [virtual]

Get the state of the dependee in order to evaluate the dependency.

Returns:
The state of the dependee.

Implements Teuchos::VisualDependency.

Definition at line 794 of file Teuchos_StandardDependencies.hpp.

template<class T >
std::string Teuchos::NumberVisualDependency< T >::getTypeAttributeValue ( ) const [virtual]

Implements Teuchos::Dependency.

Definition at line 803 of file Teuchos_StandardDependencies.hpp.

template<class T >
RCP< const SimpleFunctionObject< T > > Teuchos::NumberVisualDependency< T >::getFunctionObject ( ) const

Const version of function getter.

Definition at line 809 of file Teuchos_StandardDependencies.hpp.

template<class T >
void Teuchos::NumberVisualDependency< T >::validateDep ( ) const [protected, virtual]

Implements Teuchos::Dependency.

Definition at line 815 of file Teuchos_StandardDependencies.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines