Teuchos Package Browser (Single Doxygen Collection) Version of the Day
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:
Inheritance graph
[legend]

List of all members.

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:
dependeeThe dependee parameter.
dependentThe dependent parameter.
showIfWhen 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 188 of file Teuchos_StandardDependencies.cpp.

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

Constructs a BoolVisualDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependent parameters.
showIfWhen 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 197 of file Teuchos_StandardDependencies.cpp.


Member Function Documentation

bool Teuchos::BoolVisualDependency::getDependeeState ( ) const [virtual]

Implements Teuchos::VisualDependency.

Definition at line 206 of file Teuchos_StandardDependencies.cpp.

std::string Teuchos::BoolVisualDependency::getTypeAttributeValue ( ) const [virtual]

Implements Teuchos::Dependency.

Definition at line 210 of file Teuchos_StandardDependencies.cpp.

void Teuchos::BoolVisualDependency::validateDep ( ) const [protected, virtual]

Implements Teuchos::Dependency.

Definition at line 214 of file Teuchos_StandardDependencies.cpp.


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