Teuchos::VisualDependency Class Reference

An abstract parent class for all visual dependencies. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::VisualDependency:

List of all members.

Public Member Functions
Constructors/Destructor
	VisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency.
	VisualDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency.
	VisualDependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency.
	VisualDependency (ConstParameterEntryList dependees, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency.
Attribute/Query Methods
virtual bool	getDependeeState () const =0
	Get the state of the dependee in order to evaluate the dependency.
bool	isDependentVisible () const
	Determines whether or not the dependent is currently visible.
bool	getShowIf () const
	Get's the value of the showIf variable.
Overridden from Dependency
void	evaluate ()
Static Public Member Functions
Public Constant Accessors
static const bool &	getShowIfDefaultValue ()

---

Detailed Description

An abstract parent class for all visual dependencies.

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

Definition at line 72 of file Teuchos_StandardDependencies.hpp.

---

Constructor & Destructor Documentation

Teuchos::VisualDependency::VisualDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		bool	showIf = getShowIfDefaultValue()
	)

Constructs a VisualDependency.

Parameters:

dependee	The dependee parameter.
dependent	The dependent parameter.
showIf	When true, the depndent will be be shown if the dependee is true.

Definition at line 54 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	RCP< const ParameterEntry >	dependee,
		ParameterEntryList	dependents,
		bool	showIf = getShowIfDefaultValue()
	)

Constructs a VisualDependency.

Parameters:

dependee	The dependee parameter.
dependents	The dependent parameters.
showIf	When true, the depndent will be be shown if the dependee is true.

Definition at line 63 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	ConstParameterEntryList	dependees,
		RCP< ParameterEntry >	dependent,
		bool	showIf = getShowIfDefaultValue()
	)

Constructs a VisualDependency.

Parameters:

dependees	The dependees.
dependent	The dependent parameter.
showIf	When true, the depndent will be be shown if the dependee is true.

Definition at line 72 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	ConstParameterEntryList	dependees,
		ParameterEntryList	dependents,
		bool	showIf = getShowIfDefaultValue()
	)

Constructs a VisualDependency.

Parameters:

dependees	The dependees.
dependents	The dependets.
showIf	When true, the depndent will be be shown if the dependee is true.

Definition at line 81 of file Teuchos_StandardDependencies.cpp.

---

Member Function Documentation

virtual bool Teuchos::VisualDependency::getDependeeState

(

)

const [pure virtual]

Get the state of the dependee in order to evaluate the dependency.

Returns:

The state of the dependee.

Implemented in Teuchos::NumberVisualDependency< T >, Teuchos::ConditionVisualDependency, Teuchos::BoolVisualDependency, and Teuchos::StringVisualDependency.

bool Teuchos::VisualDependency::isDependentVisible

(

)

const

Determines whether or not the dependent is currently visible.

Definition at line 90 of file Teuchos_StandardDependencies.cpp.

bool Teuchos::VisualDependency::getShowIf

(

)

const

Get's the value of the showIf variable.

Definition at line 94 of file Teuchos_StandardDependencies.cpp.

void Teuchos::VisualDependency::evaluate

(

)

[virtual]

Implements Teuchos::Dependency.

Definition at line 98 of file Teuchos_StandardDependencies.cpp.

---

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

• Teuchos_StandardDependencies.hpp
• Teuchos_StandardDependencies.cpp