Optika GUI Toolik Version of the Day
Public Types | Public Member Functions | Private Member Functions | Private Attributes
Optika::StringVisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::StringVisualDependency:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Teuchos::Array
< std::string > 
ValueList

Public Member Functions

 StringVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, std::string value, bool showIf=true)
 StringVisualDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, std::string value, bool showIf=true)
 StringVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, const ValueList &values, bool showIf=true)
 StringVisualDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, const ValueList &values, bool showIf=true)
 StringVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, std::string value, bool showIf=true)
 StringVisualDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, const ValueList &values, bool showIf=true)
void evaluate ()

Private Member Functions

void validateDep ()

Private Attributes

const ValueList values

Detailed Description

A string visual depdencies says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee has a particular value, the dependent may or may not be displayed to the user in a GUI.

The dependee of a StringVisualDependency must be of type string and can't be an array. The dependent may be any type of parameter or parameter list.

Definition at line 193 of file Optika_StandardDependencies.hpp.


Member Typedef Documentation

Convience typedef representing an array of strings.

Definition at line 198 of file Optika_StandardDependencies.hpp.


Constructor & Destructor Documentation

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
valueThe value of the depndee that affects the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.

Definition at line 71 of file Optika_StandardDependencies.cpp.

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList parentList,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
valueThe value of the depndee that affects the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.

Definition at line 77 of file Optika_StandardDependencies.cpp.

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
valuesThe values of the depndee that affect the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to one of the values specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 83 of file Optika_StandardDependencies.cpp.

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList parentList,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
valuesThe values of the depndee that affect the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to the one of the values as specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 89 of file Optika_StandardDependencies.cpp.

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
ParameterParentMap  dependents,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
valueThe value of the depndee that affects the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to the same value as specified by the value parameter. If false, the dependent will be shown only when the dependee is set to a value other than the one specified by the value parameter.

Definition at line 95 of file Optika_StandardDependencies.cpp.

Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
ParameterParentMap  dependents,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
valuesThe values of the depndee that affect the visiblity of the dependent.
showIfWhen true, the depndent will be be shown if the dependee is set to one of the values specified by the values parameter. If false, the dependent will be shown only when the dependee is set to a value other than the ones specified by the values parameter.

Definition at line 101 of file Optika_StandardDependencies.cpp.


Member Function Documentation

void Optika::StringVisualDependency::evaluate ( ) [virtual]

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implements Optika::VisualDependency.

Definition at line 107 of file Optika_StandardDependencies.cpp.

void Optika::StringVisualDependency::validateDep ( ) [private, virtual]

Validates the dependency to make sure it's valid/has been setup properly. If subclassing, this fucntion should be called in the new subclasses constructor.

Implements Optika::VisualDependency.

Definition at line 119 of file Optika_StandardDependencies.cpp.


Member Data Documentation

The value used to deteremine the visiblity of the dependent.

Definition at line 286 of file Optika_StandardDependencies.hpp.


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