Optika::NumberVisualDependency< S > Class Template Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::NumberVisualDependency< S >:
Inheritance graph
[legend]
Collaboration diagram for Optika::NumberVisualDependency< S >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 NumberVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, S(*func)(S)=0)
 NumberVisualDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, S(*func)(S)=0)
 NumberVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, S(*func)(S)=0)
void evaluate ()

Detailed Description

template<class S>
class Optika::NumberVisualDependency< S >

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 GUI.

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.


Constructor & Destructor Documentation

template<class S >
Optika::NumberVisualDependency< S >::NumberVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  dependentParentList,
S(*)(S)  func = 0 
) [inline]

Constructs a NumberVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependentName The name of the dependent parameter.
dependentParentList The ParameterList containing the dependent.
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 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 cuasing the dependent to be hidden).
template<class S >
Optika::NumberVisualDependency< S >::NumberVisualDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  parentList,
S(*)(S)  func = 0 
) [inline]

Constructs a NumberVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependentName The name of the dependent parameter.
parentList The ParameterList containing the dependent and the dependee.
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 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 cuasing the dependent to be hidden).
template<class S >
Optika::NumberVisualDependency< S >::NumberVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
ParameterParentMap  dependents,
S(*)(S)  func = 0 
) [inline]

Constructs a NumberVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependents A map containing dependent Parameters associated with their paraent ParameterLists.
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 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 cuasing the dependent to be hidden).

Member Function Documentation

template<class S >
void Optika::NumberVisualDependency< S >::evaluate (  )  [inline, virtual]

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implements Optika::VisualDependency.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations
Generated on Wed Apr 13 10:05:55 2011 for Optika by  doxygen 1.6.3