Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::ArrayModifierDependency< DependeeType, DependentType > Class Template Referenceabstract

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 >:
Inheritance graph
[legend]

Constructor(s)

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

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

Overridden from Dependency

virtual void evaluate ()
 
virtual void validateDep () const
 

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

Private Members

RCP< const
SimpleFunctionObject
< DependeeType > > 
func_
 The function used to calculate the amount by which an arrays dimensional attribute should be modified. More...
 

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...
 
- 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...
 
const ConstParameterEntryListgetDependees () const
 Gets the dependees of the dependency. More...
 
ParameterEntryListgetDependents ()
 Gets the dependents of the dependency. More...
 
const ConstParameterEntryListgetDependents () const
 Gets the dependents of the dependency. More...
 
RCP< const ParameterEntrygetFirstDependee () const
 Gets the first dependee in the dependees list. This is a convience function. More...
 
template<class S >
getFirstDependeeValue () const
 Convienence function. Returns the first dependee in the list of dependees. More...
 
virtual std::string getTypeAttributeValue () const =0
 Returns the string to be used for the value of the type attribute when converting the dependency to XML. More...
 
virtual void print (std::ostream &out) const
 prints out information about the dependency. 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...
 
- 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...
 
- Protected Member Functions inherited from Teuchos::Dependency

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 831 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 931 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 940 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 873 of file Teuchos_StandardDependencies.hpp.

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

Implements Teuchos::Dependency.

Definition at line 961 of file Teuchos_StandardDependencies.hpp.

template<class DependeeType , class DependentType >
void Teuchos::ArrayModifierDependency< DependeeType, DependentType >::validateDep ( ) const
protectedvirtual
template<class DependeeType , class DependentType >
virtual void Teuchos::ArrayModifierDependency< DependeeType, DependentType >::modifyArray ( DependeeType  newAmount,
RCP< ParameterEntry dependentToModify 
)
protectedpure 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::TwoDColDependency< DependeeType, DependentType >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >.

template<class DependeeType , class DependentType >
virtual std::string Teuchos::ArrayModifierDependency< DependeeType, DependentType >::getBadDependentValueErrorMessage ( ) const
protectedpure 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::TwoDColDependency< DependeeType, DependentType >, Teuchos::TwoDRowDependency< DependeeType, DependentType >, and Teuchos::NumberArrayLengthDependency< DependeeType, DependentType >.

Member Data Documentation

template<class DependeeType , class DependentType >
RCP<const SimpleFunctionObject<DependeeType> > Teuchos::ArrayModifierDependency< DependeeType, DependentType >::func_
private

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

Definition at line 925 of file Teuchos_StandardDependencies.hpp.


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