Teuchos - Trilinos Tools Package Version of the Day
Teuchos::ArrayModifierDependency< DependeeType, DependentType > Class Template Reference

An abstract base class for all dependencies which modify the dimensional attributes of an Array parameter. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::ArrayModifierDependency< DependeeType, DependentType >:
Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject Teuchos::NumberArrayLengthDependency< DependeeType, DependentType > Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType > Teuchos::TwoDColDependency< DependeeType, DependentType > Teuchos::TwoDRowDependency< DependeeType, DependentType >

List of all members.

Public Member Functions

Constructor(s)
 ArrayModifierDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs an ArrayModifierDependency.
 ArrayModifierDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs an ArrayModifierDependency.
Getters
RCP< const
SimpleFunctionObject
< DependeeType > > 
getFunctionObject () const
 Retrieves the function being used to calculate the amount by which an arrays dimensional attribute should be modified.

Protected Member Functions

Pure virtual functions
virtual void modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)=0
 Modifies a particular attribute of the array according to the specific semantics of the dependency.
virtual std::string getBadDependentValueErrorMessage () const =0
 Returns the error message that should be displayed if the dependent has taken on a value that, when run through the funciton given in the constructor, returns a negative value.

Overridden from Dependency

virtual void evaluate ()
 
virtual void validateDep () const
 

Detailed Description

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

An abstract base class for all dependencies which modify the dimensional attributes of an Array parameter.

Definition at line 865 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

template<class DependeeType , class DependentType >
Teuchos::ArrayModifierDependency< DependeeType, DependentType >::ArrayModifierDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
RCP< const SimpleFunctionObject< DependeeType > >  func = null 
)

Constructs an ArrayModifierDependency.

Parameters:
dependeeThe dependee parameter.
dependentThe dependent parameter.
funcThe function to be used when calculating the amount an array dimension should be modified.

Definition at line 965 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >
Teuchos::ArrayModifierDependency< DependeeType, DependentType >::ArrayModifierDependency ( RCP< const ParameterEntry dependee,
ParameterEntryList  dependents,
RCP< const SimpleFunctionObject< DependeeType > >  func = null 
)

Constructs an ArrayModifierDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependent parameter.
funcThe function to be used when calculating the amount an array dimension should be modified.

Definition at line 974 of file Teuchos_StandardDependencies.hpp.


Member Function Documentation

template<class DependeeType , class DependentType >
RCP<const SimpleFunctionObject<DependeeType> > Teuchos::ArrayModifierDependency< DependeeType, DependentType >::getFunctionObject ( ) const [inline]

Retrieves the function being used to calculate the amount by which an arrays dimensional attribute should be modified.

Returns:
The funciton being used to calculate the amount by which an arrays dimensional attribute should be modified.

Definition at line 907 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >
void Teuchos::ArrayModifierDependency< DependeeType, DependentType >::evaluate ( ) [virtual]

Implements Teuchos::Dependency.

Definition at line 995 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >
void Teuchos::ArrayModifierDependency< DependeeType, DependentType >::validateDep ( ) const [protected, virtual]
template<class DependeeType , class DependentType >
virtual void Teuchos::ArrayModifierDependency< DependeeType, DependentType >::modifyArray ( DependeeType  newAmount,
RCP< ParameterEntry dependentToModify 
) [protected, pure virtual]

Modifies a particular attribute of the array according to the specific semantics of the dependency.

Parameters:
newAmountThe new value of the attribute which is being modified.
dependentToModifyThe dependent containing the array to be modified.

Implemented in Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::TwoDColDependency< DependeeType, DependentType >.

template<class DependeeType , class DependentType >
virtual std::string Teuchos::ArrayModifierDependency< DependeeType, DependentType >::getBadDependentValueErrorMessage ( ) const [protected, pure virtual]

Returns the error message that should be displayed if the dependent has taken on a value that, when run through the funciton given in the constructor, returns a negative value.

Returns:
Error message to be displayed when the dependnt has a bad value.

Implemented in Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::TwoDColDependency< DependeeType, DependentType >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines