Optika GUI Toolik Version of the Day
Public Member Functions | Protected Attributes | Private Member Functions
Optika::VisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::VisualDependency:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 VisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, bool showIf=true)
 VisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, bool showIf=true)
 VisualDependency (ParameterParentMap dependees, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, bool showIf=true)
 VisualDependency (ParameterParentMap dependees, ParameterParentMap dependents, bool showIf=true)
 VisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents)
 VisualDependency (ParameterParentMap dependees, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList)
 VisualDependency (ParameterParentMap dependees, ParameterParentMap dependents)
virtual ~VisualDependency ()
virtual void evaluate ()=0
bool isDependentVisible ()

Protected Attributes

bool dependentVisible
bool showIf

Private Member Functions

virtual void validateDep ()=0

Detailed Description

An abstract parent class for all visual dependencies.

IMPORTANT NOTE: If a parameter becomes hidden, it's validity will not be checked by the GUI. This means that it is indeed possible for the GUI to return a non-valid ParameterList. Make sure that you program code takes this into account.

Definition at line 44 of file Optika_StandardDependencies.hpp.


Constructor & Destructor Documentation

Optika::VisualDependency::VisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList,
bool  showIf = true 
)

Constructs a VisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 34 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
ParameterParentMap  dependents,
bool  showIf = true 
)

Constructs a VisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 38 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( ParameterParentMap  dependees,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList,
bool  showIf = true 
)

Constructs a VisualDependency.

Parameters:
dependeesA map containing all the dependee Parameters associated with their parent ParameterLists.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 42 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( ParameterParentMap  dependees,
ParameterParentMap  dependents,
bool  showIf = true 
)

Constructs a VisualDependency.

Parameters:
dependeesA map containing all the dependee Parameters associated with their parent ParameterLists.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 45 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
ParameterParentMap  dependents 
)

Constructs a VisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.

Definition at line 48 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( ParameterParentMap  dependees,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList 
)

Constructs a VisualDependency.

Parameters:
dependeesA map containing all the dependee Parameters associated with their parent ParameterLists.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.

Definition at line 52 of file Optika_StandardDependencies.cpp.

Optika::VisualDependency::VisualDependency ( ParameterParentMap  dependees,
ParameterParentMap  dependents 
)

Constructs a VisualDependency.

Parameters:
dependeesA map containing all the dependee Parameters associated with their parent ParameterLists.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.

Definition at line 55 of file Optika_StandardDependencies.cpp.

virtual Optika::VisualDependency::~VisualDependency ( ) [inline, virtual]

Desctructor

Simply declaring the descrutor as virtual.

Definition at line 120 of file Optika_StandardDependencies.hpp.


Member Function Documentation

virtual void Optika::VisualDependency::evaluate ( ) [pure virtual]

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

Implements Optika::Dependency.

Implemented in Optika::StringVisualDependency, Optika::BoolVisualDependency, Optika::ConditionVisualDependency, and Optika::NumberVisualDependency< S >.

bool Optika::VisualDependency::isDependentVisible ( )

Determines whether or not the dependent is currently visible.

Definition at line 58 of file Optika_StandardDependencies.cpp.

virtual void Optika::VisualDependency::validateDep ( ) [private, pure 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::Dependency.

Implemented in Optika::StringVisualDependency, Optika::BoolVisualDependency, Optika::ConditionVisualDependency, and Optika::NumberVisualDependency< S >.


Member Data Documentation

Whether or not the dependent is currently visible.

Definition at line 134 of file Optika_StandardDependencies.hpp.

Whether or not to show the dependent if the dependee is set to the value.

Definition at line 139 of file Optika_StandardDependencies.hpp.


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