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

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 UI. More...

#include <Teuchos_StandardDependencies.hpp>

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

List of all members.

Public types

typedef Array< std::string > ValueList

Constructors/Destructor

 StringVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, std::string value, bool showIf=true)
 Constructs a StringVisualDependency.
 StringVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, const ValueList &values, bool showIf=true)
 Constructs a StringVisualDependency.
 StringVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, const std::string &value, bool showIf=true)
 Constructs a StringVisualDependency.
 StringVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, const ValueList &values, bool showIf=true)
 Constructs a StringVisualDependency.

Attribute/Query Functions

const ValueListgetValues () const
 get the List of values the dependee will be checked against.

Overridden from VisualDependency

bool getDependeeState () const
 

Overridden from Dependency

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

Private Members

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 UI.

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.

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

Definition at line 244 of file Teuchos_StandardDependencies.hpp.


Member Typedef Documentation

Convience typedef representing an array of strings.

Definition at line 254 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
std::string  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeThe dependee paramter. dependent The dependent parameter.
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 109 of file Teuchos_StandardDependencies.cpp.

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
const ValueList values,
bool  showIf = true 
)

Constructs a StringVisualDependency.

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

Teuchos::StringVisualDependency::StringVisualDependency ( RCP< const ParameterEntry dependee,
Dependency::ParameterEntryList  dependents,
const std::string &  value,
bool  showIf = true 
)

Constructs a StringVisualDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependents
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 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 131 of file Teuchos_StandardDependencies.cpp.

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

Constructs a StringVisualDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependents
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 142 of file Teuchos_StandardDependencies.cpp.


Member Function Documentation

const StringVisualDependency::ValueList & Teuchos::StringVisualDependency::getValues ( ) const

get the List of values the dependee will be checked against.

Definition at line 154 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::VisualDependency.

Definition at line 159 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 164 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 168 of file Teuchos_StandardDependencies.cpp.


Member Data Documentation

The value used to deteremine the visiblity of the dependent.

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