Teuchos::BoolVisualDependency Class Reference

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. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::BoolVisualDependency:

List of all members.

Public Member Functions
Constructors/Destructor
	BoolVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=true)
	BoolVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, bool showIf=true)
Overridden from VisualDependency
bool	getDependeeState () const
Overridden from Dependency
std::string	getTypeAttributeValue () const
void	validateDep () const

---

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.

Please see BoolVisualDependencyXMLConverter for documentation regarding the XML representation of this Dependency.

Definition at line 425 of file Teuchos_StandardDependencies.hpp.

---

Constructor & Destructor Documentation

Teuchos::BoolVisualDependency::BoolVisualDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		bool	showIf = true
	)

Constructs a BoolVisualDependency.

Parameters:

dependee	The dependee parameter.
dependent	The dependent parameter.
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.

Definition at line 196 of file Teuchos_StandardDependencies.cpp.

Teuchos::BoolVisualDependency::BoolVisualDependency	(	RCP< const ParameterEntry >	dependee,
		Dependency::ParameterEntryList	dependents,
		bool	showIf = true
	)

Constructs a BoolVisualDependency.

Parameters:

dependee	The dependee parameter.
dependents	The dependent parameters.
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.

Definition at line 205 of file Teuchos_StandardDependencies.cpp.

---

Member Function Documentation

bool Teuchos::BoolVisualDependency::getDependeeState

(

)

const [virtual]

Implements Teuchos::VisualDependency.

Definition at line 214 of file Teuchos_StandardDependencies.cpp.

std::string Teuchos::BoolVisualDependency::getTypeAttributeValue

(

)

const [virtual]

Implements Teuchos::Dependency.

Definition at line 218 of file Teuchos_StandardDependencies.cpp.

void Teuchos::BoolVisualDependency::validateDep

(

)

const [protected, virtual]

Implements Teuchos::Dependency.

Definition at line 222 of file Teuchos_StandardDependencies.cpp.

---

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

• Teuchos_StandardDependencies.hpp
• Teuchos_StandardDependencies.cpp