Optika::VisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::VisualDependency:

Collaboration diagram for Optika::VisualDependency:

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

---

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.

---

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:

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.

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

Constructs a VisualDependency.

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.

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

Constructs a VisualDependency.

Parameters:

dependees	A map containing all the dependee Parameters associated with their parent ParameterLists.
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.

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

Constructs a VisualDependency.

Parameters:

dependees	A map containing all the dependee Parameters associated with their parent ParameterLists.
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.

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

Constructs a VisualDependency.

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.

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

Constructs a VisualDependency.

Parameters:

dependees	A map containing all the dependee Parameters associated with their parent ParameterLists.
dependentName	The name of the dependent parameter.
dependentParentList	The ParameterList containing the dependent.

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

Constructs a VisualDependency.

Parameters:

dependees	A map containing all the dependee Parameters associated with their parent ParameterLists.
dependents	A map containing dependent Parameters associated with their paraent ParameterLists.

virtual Optika::VisualDependency::~VisualDependency

(

)

[inline, virtual]

Desctructor

Simply declaring the descrutor as virtual.

---

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.

---

Member Data Documentation

bool Optika::VisualDependency::dependentVisible [protected]

Whether or not the dependent is currently visible.

bool Optika::VisualDependency::showIf [protected]

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

---

The documentation for this class was generated from the following files:

• Optika_StandardDependencies.hpp
• Optika_StandardDependencies.cpp