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:

List of all members.

Public Types
Public types
typedef Array< std::string >	ValueList
Public Member Functions
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 ValueList &	getValues () 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

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

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

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:

dependee	The dependee paramter. dependent The dependent parameter.
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.

Definition at line 117 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:

dependee	The dependee parameter.
dependent	The dependent parameter.
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.

Definition at line 128 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:

dependee	The dependee parameter.
dependents	The dependents
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 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 139 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:

dependee	The dependee parameter.
dependents	The dependents
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.

Definition at line 150 of file Teuchos_StandardDependencies.cpp.