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

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

#include <Teuchos_StandardDependencies.hpp>

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

List of all members.

Public Constant Accessors

static const bool & getShowIfDefaultValue ()

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 ()
 

Private Members

bool dependentVisible_
 Whether or not the dependent is currently visible.
bool showIf_
 Whether or not to show the dependent if the dependee is set to the value.

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:
dependeeThe dependee parameter.
dependentThe dependent parameter.
showIfWhen 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:
dependeeThe dependee parameter.
dependentsThe dependent parameters.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 61 of file Teuchos_StandardDependencies.cpp.

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

Constructs a VisualDependency.

Parameters:
dependeesThe dependees.
dependentThe dependent parameter.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 68 of file Teuchos_StandardDependencies.cpp.

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

Constructs a VisualDependency.

Parameters:
dependeesThe dependees.
dependentsThe dependets.
showIfWhen true, the depndent will be be shown if the dependee is true.

Definition at line 75 of file Teuchos_StandardDependencies.cpp.


Member Function Documentation

static const bool& Teuchos::VisualDependency::getShowIfDefaultValue ( ) [inline, static]

Definition at line 77 of file Teuchos_StandardDependencies.hpp.

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::StringVisualDependency, Teuchos::BoolVisualDependency, Teuchos::ConditionVisualDependency, and Teuchos::NumberVisualDependency< T >.

bool Teuchos::VisualDependency::isDependentVisible ( ) const

Determines whether or not the dependent is currently visible.

Definition at line 82 of file Teuchos_StandardDependencies.cpp.

bool Teuchos::VisualDependency::getShowIf ( ) const

Get's the value of the showIf variable.

Definition at line 86 of file Teuchos_StandardDependencies.cpp.

void Teuchos::VisualDependency::evaluate ( ) [virtual]

Implements Teuchos::Dependency.

Definition at line 90 of file Teuchos_StandardDependencies.cpp.


Member Data Documentation

Whether or not the dependent is currently visible.

Definition at line 177 of file Teuchos_StandardDependencies.hpp.

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

Definition at line 183 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