Optika::StringVisualDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::StringVisualDependency:
Inheritance graph
[legend]
Collaboration diagram for Optika::StringVisualDependency:
Collaboration 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 ()

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.


Member Typedef Documentation

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

Convience typedef representing an array of strings.


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:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependentName The name of the dependent parameter.
dependentParentList The ParameterList containing the dependent.
value The value of the depndee that affects the visiblity of the dependent.
showIf When 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.
Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  parentList,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependentName The name of the dependent parameter.
parentList The ParameterList containing the dependent and the dependee.
value The value of the depndee that affects the visiblity of the dependent.
showIf When 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.
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:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependentName The name of the dependent parameter.
dependentParentList The ParameterList containing the dependent.
values The values of the depndee that affect the visiblity of the dependent.
showIf When 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.
Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  parentList,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependentName The name of the dependent parameter.
parentList The ParameterList containing the dependent and the dependee.
values The values of the depndee that affect the visiblity of the dependent.
showIf When 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.
Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
ParameterParentMap  dependents,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependents A map containing dependent Parameters associated with their paraent ParameterLists.
value The value of the depndee that affects the visiblity of the dependent.
showIf When 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.
Optika::StringVisualDependency::StringVisualDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
ParameterParentMap  dependents,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependents A map containing dependent Parameters associated with their paraent ParameterLists.
values The values of the depndee that affect the visiblity of the dependent.
showIf When 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.

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.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations
Generated on Wed Apr 13 10:05:55 2011 for Optika by  doxygen 1.6.3