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

A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of another parameter. More...

#include <Teuchos_StandardDependencies.hpp>

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

List of all members.

Public Member Functions

Constructors/Destructor
 TwoDRowDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs a TwoDRowDependency.
 TwoDRowDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs a TwoDRowDependency.
Overridden from Dependency
std::string getTypeAttributeValue () const
 

Protected Member Functions

Overridden from ArrayModifierDependency
void modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
 
std::string getBadDependentValueErrorMessage () const
 

Detailed Description

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

A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of another parameter.

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

Definition at line 1922 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

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

Constructs a TwoDRowDependency.

Parameters:
dependeeThe dependee parameter.
dependentThe dependent parameter.
funcA function specifying how the TwoDArrays number of rows should be calculated from the dependees value.

Definition at line 1984 of file Teuchos_StandardDependencies.hpp.

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

Constructs a TwoDRowDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependents.
funcA function specifying how the TwoDArrays number of rows should be calculated from the dependees value.

Definition at line 1995 of file Teuchos_StandardDependencies.hpp.


Member Function Documentation

template<class DependeeType , class DependentType >
std::string Teuchos::TwoDRowDependency< DependeeType, DependentType >::getTypeAttributeValue ( ) const [virtual]

Implements Teuchos::Dependency.

Definition at line 2008 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >
void Teuchos::TwoDRowDependency< DependeeType, DependentType >::modifyArray ( DependeeType  newAmount,
RCP< ParameterEntry dependentToModify 
) [protected, virtual]
template<class DependeeType , class DependentType >
std::string Teuchos::TwoDRowDependency< 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