Optika Development
Public Member Functions
Optika::ConditionVisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::ConditionVisualDependency:
Inheritance graph
[legend]
Collaboration diagram for Optika::ConditionVisualDependency:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ConditionVisualDependency (Teuchos::RCP< Condition > condition, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, bool showIf=true)
 ConditionVisualDependency (Teuchos::RCP< Condition > condition, ParameterParentMap dependents, bool showIf=true)
void evaluate ()
void validateDep ()

Detailed Description

A condition visual dependency says the following about the relationship between elements in a Parameter List: Depending on whether or not the dependee(s) statisfy a particual condition, the dependent may or may not be displayed to the user in a GUI.

Conditoin Visual Dependencies are unique in that via the Condition class, they allow for multiple dependees. The dependee(s) of a ConditionVisualDependency must be expressed as a Condition and are subject to the consquential constraints. The dependent may be any type of parameter or parameter list.


Constructor & Destructor Documentation

Optika::ConditionVisualDependency::ConditionVisualDependency ( Teuchos::RCP< Condition condition,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  dependentParentList,
bool  showIf = true 
)

Constructs a ConditionVisualDependency.

Parameters:
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the dependee is false.
Optika::ConditionVisualDependency::ConditionVisualDependency ( Teuchos::RCP< Condition condition,
ParameterParentMap  dependents,
bool  showIf = true 
)

Constructs a BoolVisualDependency.

Parameters:
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the dependee is false.

Member Function Documentation

void Optika::ConditionVisualDependency::evaluate ( ) [virtual]

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

Implements Optika::VisualDependency.

void Optika::ConditionVisualDependency::validateDep ( ) [virtual]

Validates the dependency to make sure it's valid/has been setup properly. If subclassing, this fucntion should be called in the new subclasses constructor.

Implements Optika::VisualDependency.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations