Teuchos - Trilinos Tools Package Version of the Day
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 >:
Teuchos::ArrayModifierDependency< DependeeType, DependentType > Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject

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:

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:
dependeeThe dependee parameter.
dependentThe dependent parameter.
funcA 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:
dependeeThe dependee parameter.
dependentsThe dependents.
funcA 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]
template<class DependeeType , class DependentType >
void Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::modifyArray ( DependeeType  newAmount,
RCP< ParameterEntry dependentToModify 
) [protected, virtual]
template<class DependeeType , class DependentType >
std::string Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >::getBadDependentValueErrorMessage ( ) const [protected, virtual]

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