An abstract parent class for all visual dependencies. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::VisualDependency:

Public Constant Accessors
static const bool &	getShowIfDefaultValue ()

Constructors/Destructor
	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...

Attribute/Query Methods
virtual bool	getDependeeState () const =0
	Get the state of the dependee in order to evaluate the dependency. 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...

Overridden from Dependency
void	evaluate ()

Private Members
bool	dependentVisible_
	Whether or not the dependent is currently visible. More...

bool	showIf_
	Whether or not to show the dependent if the dependee is set to the value. More...

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::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 std::string	getTypeAttributeValue () const =0
	Returns the string to be used for the value of the type attribute when converting the dependency to XML. 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::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
virtual void	validateDep () const =0
	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. More...

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

An abstract parent class for all visual dependencies.

IMPORTANT NOTE: If a parameter becomes hidden, it's validity will not necessarily be checked. This means that it is indeed possible for a non-valid ParameterList to occur. Make sure that you program code takes this into account.

Definition at line 38 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

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

Constructs a VisualDependency.

Parameters

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

Definition at line 17 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	RCP< const ParameterEntry >	dependee,
		ParameterEntryList	dependents,
		bool	showIf = `getShowIfDefaultValue()`
	)

Constructs a VisualDependency.

Parameters

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

Definition at line 26 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	ConstParameterEntryList	dependees,
		RCP< ParameterEntry >	dependent,
		bool	showIf = `getShowIfDefaultValue()`
	)

Constructs a VisualDependency.

Parameters

dependees	The dependees.
dependent	The dependent parameter.
showIf	When true, the depndent will be be shown if the dependee is true.

Definition at line 35 of file Teuchos_StandardDependencies.cpp.

Teuchos::VisualDependency::VisualDependency	(	ConstParameterEntryList	dependees,
		ParameterEntryList	dependents,
		bool	showIf = `getShowIfDefaultValue()`
	)