Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos::ConditionVisualDependency Class Reference

A condition visual dependency says the following about the relationship between elements in a Parameter List: Depending on whether or not the dependee(s) statisfy a particual condition, the dependent may or may not be displayed to the user in a UI. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::ConditionVisualDependency:
Inheritance graph
[legend]

List of all members.

Constructors/Destructor

 ConditionVisualDependency (RCP< const Condition > condition, RCP< ParameterEntry > dependent, bool showIf=true)
 ConditionVisualDependency (RCP< const Condition > condition, Dependency::ParameterEntryList dependents, bool showIf=true)

Getter Functions

RCP< const ConditiongetCondition () const
 Gets the condition being used in this dependency.

Overridden from VisualDependency

bool getDependeeState () const
 

Overridden from Dependency

std::string getTypeAttributeValue () const
 
void validateDep () const
 

Private Members

RCP< const Conditioncondition_
 The Condition to determine whether or not the dependent is displayed.

Detailed Description

A condition visual dependency says the following about the relationship between elements in a Parameter List: Depending on whether or not the dependee(s) statisfy a particual condition, the dependent may or may not be displayed to the user in a UI.

Condition Visual Dependencies are unique in that via the Condition class, they allow for multiple dependees. The dependee(s) of a ConditionVisualDependency must be expressed as a Condition and are subject to the consquential constraints. The dependent may be any type of parameter or parameter list.

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

Definition at line 529 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

Teuchos::ConditionVisualDependency::ConditionVisualDependency ( RCP< const Condition condition,
RCP< ParameterEntry dependent,
bool  showIf = true 
)

Constructs a ConditionVisualDependency.

Parameters:
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the condition is false.

Definition at line 232 of file Teuchos_StandardDependencies.cpp.

Teuchos::ConditionVisualDependency::ConditionVisualDependency ( RCP< const Condition condition,
Dependency::ParameterEntryList  dependents,
bool  showIf = true 
)

Constructs a ConditionVisualDependency.

Parameters:
conditionThe condition that must be satisfied in order to display the dependent parameter.
dependentsThe dependent parameters.
showIfWhen true, the depndent will be be shown if the condition is true. If false, the dependent will be shown only when the condition is false.

Definition at line 242 of file Teuchos_StandardDependencies.cpp.


Member Function Documentation

RCP< const Condition > Teuchos::ConditionVisualDependency::getCondition ( ) const

Gets the condition being used in this dependency.

Definition at line 252 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::VisualDependency.

Definition at line 256 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 260 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 597 of file Teuchos_StandardDependencies.hpp.


Member Data Documentation

The Condition to determine whether or not the dependent is displayed.

Definition at line 610 of file Teuchos_StandardDependencies.hpp.


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