A NumberArrayLengthDependency says the following about the relationship between two parameters: The length of the dependent's array depends on the value of the dependee. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >:

Public Member Functions
Constructors/Destructor
	NumberArrayLengthDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a NumberArrayLengthDependency. More...

	NumberArrayLengthDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a NumberArrayLengthDependency. More...

Overridden from Dependency
std::string	getTypeAttributeValue () const

Public Member Functions inherited from Teuchos::ArrayModifierDependency< DependeeType, DependentType >
	ArrayModifierDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs an ArrayModifierDependency. More...

	ArrayModifierDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs an ArrayModifierDependency. More...

RCP< const SimpleFunctionObject< DependeeType > >	getFunctionObject () const
	Retrieves the function being used to calculate the amount by which an arrays dimensional attribute should be modified. More...

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

virtual void	print (std::ostream &out) const
	prints out information about the 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...

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

Protected Member Functions
Overridden from ArrayModifierDependency
virtual void	validateDep () const

void	modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)

std::string	getBadDependentValueErrorMessage () const

Protected Member Functions inherited from Teuchos::ArrayModifierDependency< DependeeType, DependentType >
Validation Functions

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

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

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

template<class DependeeType, class DependentType>
class Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >

A NumberArrayLengthDependency says the following about the relationship between two parameters: The length of the dependent's array depends on the value of the dependee.

A NumberArrayLengthDependency must have the following characteristics:

The dependee type must be an ordinal.

The dependent must be an array.

When supplying template parameters for this class, the dependent type should be the type which the dependent array is templated on. For example: if the dependent is of type Array<int> then the NumberArrayLengthDependency's dependent template parameter should be set to int.

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

Definition at line 1038 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

◆ NumberArrayLengthDependency() [1/2]

template<class DependeeType , class DependentType >

Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::NumberArrayLengthDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		RCP< const SimpleFunctionObject< DependeeType > >	func = `null`
	)

Constructs a NumberArrayLengthDependency.

Parameters

dependee	The dependee parameter.
dependent	The dependent parameter.
func	A function specifying how the arrays length should be calculated from the dependees value.

Definition at line 1102 of file Teuchos_StandardDependencies.hpp.

◆ NumberArrayLengthDependency() [2/2]

template<class DependeeType , class DependentType >

Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::NumberArrayLengthDependency	(	RCP< const ParameterEntry >	dependee,
		Dependency::ParameterEntryList	dependents,
		RCP< const SimpleFunctionObject< DependeeType > >	func = `null`
	)

Constructs a NumberArrayLengthDependency.

Parameters

dependee	The dependee parameter.
dependents	The dependents.
func	A function specifying how the arrays length should be calculated from the dependees value.

Definition at line 1112 of file Teuchos_StandardDependencies.hpp.

Member Function Documentation

◆ getTypeAttributeValue()

template<class DependeeType , class DependentType >

std::string Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::getTypeAttributeValue ( ) const

virtual

Implements Teuchos::Dependency.

Definition at line 1124 of file Teuchos_StandardDependencies.hpp.

◆ validateDep()

template<class DependeeType , class DependentType >

void Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::validateDep ( ) const

protectedvirtual

Reimplemented from Teuchos::ArrayModifierDependency< DependeeType, DependentType >.

Definition at line 1169 of file Teuchos_StandardDependencies.hpp.

◆ modifyArray()

template<class DependeeType , class DependentType >

void Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::modifyArray	(	DependeeType	newAmount,
		RCP< ParameterEntry >	dependentToModify
	)