A bool visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee is true or false, the dependent may or may not be displayed to the user in a GUI. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::BoolVisualDependency:

[legend]

Constructors/Destructor
	BoolVisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=true)

	BoolVisualDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, bool showIf=true)

Overridden from VisualDependency
bool	getDependeeState () const

Overridden from Dependency
std::string	getTypeAttributeValue () const

void	validateDep () const

Additional Inherited Members
Public Types inherited from Teuchos::Dependency
typedef std::set< RCP < ParameterEntry >, RCPComp >	ParameterEntryList
	A list of Dependees. More...

typedef std::set< RCP< const ParameterEntry >, RCPConstComp >	ConstParameterEntryList
	A list of dependents. More...

Public Member Functions inherited from Teuchos::VisualDependency
	VisualDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency. More...

	VisualDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency. More...

	VisualDependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency. More...

	VisualDependency (ConstParameterEntryList dependees, ParameterEntryList dependents, bool showIf=getShowIfDefaultValue())
	Constructs a VisualDependency. More...

bool	isDependentVisible () const
	Determines whether or not the dependent is currently visible. More...

bool	getShowIf () const
	Get's the value of the showIf variable. More...

void	evaluate ()

Public Member Functions inherited from Teuchos::Dependency
	Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
	Constructs a Dependency. More...

	Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent)
	Constructs a Dependency. More...

	Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
	Constructs a Dependency. More...

	Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
	Constructs a Dependency. More...

const ConstParameterEntryList &	getDependees () const
	Gets the dependees of the dependency. More...

ParameterEntryList &	getDependents ()
	Gets the dependents of the dependency. More...

const ConstParameterEntryList &	getDependents () const
	Gets the dependents of the dependency. More...

RCP< const ParameterEntry >	getFirstDependee () const
	Gets the first dependee in the dependees list. This is a convience function. More...

template<class S >
S	getFirstDependeeValue () const
	Convienence function. Returns the first dependee in the list of dependees. More...

virtual void	print (std::ostream &out) const
	prints out information about the dependency. More...

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object. More...

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream. More...

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream. More...

virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes). More...

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label. More...

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject). More...

virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject). More...

Static Public Member Functions inherited from Teuchos::VisualDependency
static const bool &	getShowIfDefaultValue ()

Static Public Member Functions inherited from Teuchos::Dependency
static const std::string &	getXMLTagName ()
	Returns the XML tag to use when serializing Dependencies. More...

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe(). More...

Protected Member Functions inherited from Teuchos::Dependency
Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

Detailed Description

A bool visual dependency says the following about the relationship between two elements in a Parameter List: Depending on whether or not the dependee is true or false, the dependent may or may not be displayed to the user in a GUI.

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

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

Definition at line 425 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

Teuchos::BoolVisualDependency::BoolVisualDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		bool	showIf = `true`
	)

Constructs a BoolVisualDependency.

Parameters

dependee	The dependee parameter.
dependent	The dependent parameter.
showIf	When true, the depndent will be be shown if the dependee is true. If false, the dependent will be shown only when the dependee is false.

Definition at line 193 of file Teuchos_StandardDependencies.cpp.

Teuchos::BoolVisualDependency::BoolVisualDependency	(	RCP< const ParameterEntry >	dependee,
		Dependency::ParameterEntryList	dependents,
		bool	showIf = `true`
	)

Constructs a BoolVisualDependency.

Parameters

dependee	The dependee parameter.
dependents	The dependent parameters.
showIf	When true, the depndent will be be shown if the dependee is true. If false, the dependent will be shown only when the dependee is false.

Definition at line 202 of file Teuchos_StandardDependencies.cpp.