This class represents a depndency between elements in a Parameter List. More...

#include <Teuchos_Dependency.hpp>

Inheritance diagram for Teuchos::Dependency:

Public types
typedef std::set< RCP< ParameterEntry >, RCPComp >	ParameterEntryList
	A list of Dependees.

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

Private Members
ConstParameterEntryList	dependees_
	The parameters being depended upon.

ParameterEntryList	dependents_
	The dependent paramters.

ConstParameterEntryList	constDependents_
	A const version dependent paramters.

	Dependency ()
	Declaring and defining the default constructor as private.

void	createConstDependents ()
	creates a const version of the dependent parameters.

void	checkDependeesAndDependents ()
	makes sure the none of the dependess and dependets are null.

Constructors/Destructor
	Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
	Constructs a Dependency.

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

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

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

Attribute/Query Methods
const ConstParameterEntryList &	getDependees () const
	Gets the dependees of the dependency.

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

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

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

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

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.

static const std::string &	getXMLTagName ()
	Returns the XML tag to use when serializing Dependencies.

Evalutation Functions
virtual void	evaluate ()=0
	Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

I/O Functions
virtual void	print (std::ostream &out) const
	prints out information about the dependency.

Validation Functions
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.

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

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

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

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

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

virtual	~LabeledObject ()

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

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

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

Related Symbols inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator.

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

Detailed Description

This class represents a depndency between elements in a Parameter List.

\reference DependencySheet \reference ParameterList

Definition at line 64 of file Teuchos_Dependency.hpp.

Member Typedef Documentation

◆ ParameterEntryList

typedef std::set<RCP<ParameterEntry>, RCPComp > Teuchos::Dependency::ParameterEntryList

A list of Dependees.

Definition at line 74 of file Teuchos_Dependency.hpp.

◆ ConstParameterEntryList

typedef std::set<RCP<const ParameterEntry>, RCPConstComp > Teuchos::Dependency::ConstParameterEntryList

A list of dependents.

Definition at line 79 of file Teuchos_Dependency.hpp.

Constructor & Destructor Documentation

◆ Dependency() [1/5]

Teuchos::Dependency::Dependency	(	ConstParameterEntryList	dependees,
		ParameterEntryList	dependents )

Constructs a Dependency.

Parameters

dependees	A list of all the dependees.
dependents	A list of all the dependents.

Definition at line 48 of file Teuchos_Dependency.cpp.

◆ Dependency() [2/5]

Teuchos::Dependency::Dependency	(	ConstParameterEntryList	dependees,
		RCP< ParameterEntry >	dependent )

Constructs a Dependency.

Parameters

dependees	A list of all the dependees.
dependent	The dependent parameter.

Definition at line 57 of file Teuchos_Dependency.cpp.

◆ Dependency() [3/5]

Teuchos::Dependency::Dependency	(	RCP< const ParameterEntry >	dependee,
		ParameterEntryList	dependents )

Constructs a Dependency.

Parameters

dependee	The dependee parameter.
dependents	A List of all the dependents.

Definition at line 68 of file Teuchos_Dependency.cpp.

◆ Dependency() [4/5]

Teuchos::Dependency::Dependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent )

Constructs a Dependency.

Parameters

dependee	The dependee parameter.
dependent	The dependent parameter.

Definition at line 78 of file Teuchos_Dependency.cpp.

◆ Dependency() [5/5]

Teuchos::Dependency::Dependency ( )

inlineprivate

Declaring and defining the default constructor as private.

Definition at line 250 of file Teuchos_Dependency.hpp.

Member Function Documentation

◆ getDependees()

const ConstParameterEntryList & Teuchos::Dependency::getDependees ( ) const

inline

Gets the dependees of the dependency.

Returns: The dependees of the dependency.

Definition at line 136 of file Teuchos_Dependency.hpp.

◆ getDependents() [1/2]

ParameterEntryList & Teuchos::Dependency::getDependents ( )

inline

Gets the dependents of the dependency.

Returns: The dependents of the dependency.

Definition at line 145 of file Teuchos_Dependency.hpp.

◆ getDependents() [2/2]

const ConstParameterEntryList & Teuchos::Dependency::getDependents ( ) const

inline

Gets the dependents of the dependency.

Returns: The dependents of the dependency.

Definition at line 154 of file Teuchos_Dependency.hpp.

◆ getFirstDependee()

RCP< const ParameterEntry > Teuchos::Dependency::getFirstDependee ( ) const

inline

Gets the first dependee in the dependees list. This is a convience function.

Definition at line 162 of file Teuchos_Dependency.hpp.

◆ getFirstDependeeValue()

template<class S >

S Teuchos::Dependency::getFirstDependeeValue ( ) const

inline

Convienence function. Returns the first dependee in the list of dependees.

Returns: The first dependee in the list of dependees.

Definition at line 173 of file Teuchos_Dependency.hpp.

◆ getTypeAttributeValue()

virtual std::string Teuchos::Dependency::getTypeAttributeValue ( ) const

pure virtual

Returns the string to be used for the value of the type attribute when converting the dependency to XML.

Implemented in Teuchos::StringVisualDependency, Teuchos::BoolVisualDependency, Teuchos::ConditionVisualDependency, Teuchos::NumberVisualDependency< T >, Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::TwoDColDependency< DependeeType, DependentType >.

◆ getXMLTagName()

static const std::string & Teuchos::Dependency::getXMLTagName ( )

inlinestatic

Returns the XML tag to use when serializing Dependencies.

Definition at line 187 of file Teuchos_Dependency.hpp.

◆ evaluate()

virtual void Teuchos::Dependency::evaluate ( )

pure virtual

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implemented in Teuchos::VisualDependency, Teuchos::ArrayModifierDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, and Teuchos::ValidatorDependency.

◆ print()

void Teuchos::Dependency::print ( std::ostream & out ) const

virtual

prints out information about the dependency.

Definition at line 99 of file Teuchos_Dependency.cpp.

◆ validateDep()

virtual void Teuchos::Dependency::validateDep ( ) const

protectedpure virtual

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.

Implemented in Teuchos::StringVisualDependency, Teuchos::BoolVisualDependency, Teuchos::ConditionVisualDependency, Teuchos::NumberVisualDependency< T >, Teuchos::ArrayModifierDependency< DependeeType, DependentType >, Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::StringValidatorDependency, Teuchos::BoolValidatorDependency, Teuchos::RangeValidatorDependency< T >, and Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >.

◆ createConstDependents()

void Teuchos::Dependency::createConstDependents ( )

private

creates a const version of the dependent parameters.

Definition at line 89 of file Teuchos_Dependency.cpp.

◆ checkDependeesAndDependents()

void Teuchos::Dependency::checkDependeesAndDependents ( )

private

makes sure the none of the dependess and dependets are null.

Definition at line 106 of file Teuchos_Dependency.cpp.

Member Data Documentation

◆ dependees_

ConstParameterEntryList Teuchos::Dependency::dependees_

private

The parameters being depended upon.

Definition at line 235 of file Teuchos_Dependency.hpp.

◆ dependents_

ParameterEntryList Teuchos::Dependency::dependents_

private

The dependent paramters.

Definition at line 240 of file Teuchos_Dependency.hpp.

◆ constDependents_

ConstParameterEntryList Teuchos::Dependency::constDependents_

private

A const version dependent paramters.

Definition at line 245 of file Teuchos_Dependency.hpp.

The documentation for this class was generated from the following files:

Public types

Private Members

Constructors/Destructor

Attribute/Query Methods

Evalutation Functions

I/O Functions

Validation Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParameterEntryList

◆ ConstParameterEntryList

Constructor & Destructor Documentation

◆ Dependency() [1/5]

◆ Dependency() [2/5]

◆ Dependency() [3/5]

◆ Dependency() [4/5]

◆ Dependency() [5/5]

Member Function Documentation

◆ getDependees()

◆ getDependents() [1/2]

◆ getDependents() [2/2]

◆ getFirstDependee()

◆ getFirstDependeeValue()

◆ getTypeAttributeValue()

◆ getXMLTagName()

◆ evaluate()

◆ print()

◆ validateDep()

◆ createConstDependents()

◆ checkDependeesAndDependents()

Member Data Documentation

◆ dependees_

◆ dependents_

◆ constDependents_