Optika::BoolVisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::BoolVisualDependency:

Collaboration diagram for Optika::BoolVisualDependency:

List of all members.

Public Member Functions
	BoolVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, bool showIf=true)
	BoolVisualDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, bool showIf=true)
	BoolVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, bool showIf=true)
void	evaluate ()
void	validateDep ()

---

Detailed Description

A bool visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee is true or false, the dependent may or may not be displayed to the user in a GUI.

The dependee of a BoolVisualDependency must be of type bool and can't be an array. The dependent may be any type of parameter or parameter list.

---

Constructor & Destructor Documentation

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

Constructs a BoolVisualDependency.

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.
showIf	When true, the depndent will be be shown if the dependee is true. If false, the dependent will be shown only when the dependee is false.

Optika::BoolVisualDependency::BoolVisualDependency	(	std::string	dependeeName,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	parentList,
		bool	showIf = true
	)

Constructs a BoolVisualDependency.

Parameters:

dependeeName	The name of the dependee parameter.
dependentName	The name of the dependent parameter.
parentList	The ParameterList containing the dependent and the dependee.
showIf	When true, the depndent will be be shown if the dependee is true. If false, the dependent will be shown only when the dependee is false.

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

Constructs a BoolVisualDependency.

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.
showIf	When true, the depndent will be be shown if the dependee is true. If false, the dependent will be shown only when the dependee is false.

---

Member Function Documentation

void Optika::BoolVisualDependency::evaluate

(

)

[virtual]

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

Implements Optika::VisualDependency.

void Optika::BoolVisualDependency::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:

• Optika_StandardDependencies.hpp
• Optika_StandardDependencies.cpp