Teuchos::NumberArrayLengthDependency< DependeeType, DependentType > Class Template Reference

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

List of all members.

Public Member Functions
Constructors/Destructor
	NumberArrayLengthDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a NumberArrayLengthDependency.
	NumberArrayLengthDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a NumberArrayLengthDependency.
Overridden from Dependency
std::string	getTypeAttributeValue () const
Protected Member Functions
Overridden from ArrayModifierDependency
virtual void	validateDep () const
void	modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
std::string	getBadDependentValueErrorMessage () const

---

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

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.

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

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.

template<class DependeeType , class DependentType >

void Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::validateDep

(

)

const [protected, virtual]

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

Definition at line 1169 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >

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

Implements Teuchos::ArrayModifierDependency< DependeeType, DependentType >.

Definition at line 1134 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >

std::string Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::getBadDependentValueErrorMessage

(

)

const [protected, virtual]

Implements Teuchos::ArrayModifierDependency< DependeeType, DependentType >.

Definition at line 1155 of file Teuchos_StandardDependencies.hpp.

---

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

• Teuchos_StandardDependencies.hpp