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 >:

[legend]

List of all members.

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.
Overridden from Dependency
std::string	getTypeAttributeValue () const

void	validateDep () const

Getter Functions
RCP< const SimpleFunctionObject< T > >	getFunctionObject () const
	Const version of function getter.
Private Members
RCP< SimpleFunctionObject< T > >	func_
	the function used to determine the visibility of the dependent.

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:

dependee	The dependee parameter.
dependent	The dependent parameter.
showIf	When 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.
func	A 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:

dependee	The dependee parameter.
dependents	The dependents.
showIf	When 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.
func	A 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.