Optika Development
Public Member Functions
Optika::NumberArrayLengthDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::NumberArrayLengthDependency:
Inheritance graph
[legend]
Collaboration diagram for Optika::NumberArrayLengthDependency:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 NumberArrayLengthDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, int(*func)(int)=0)
 NumberArrayLengthDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, int(*func)(int)=0)
 NumberArrayLengthDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, int(*func)(int)=0)
void evaluate ()

Detailed Description

An ArrayLengthDependency says the following about the relationship between two parameters: The length of the dependent's array depends on the value of the dependee.

An ArrayLengthDependency must have the following characteristics:


Constructor & Destructor Documentation

Optika::NumberArrayLengthDependency::NumberArrayLengthDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  dependentParentList,
int(*)(int)  func = 0 
)

Constructs an ArrayLengthDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
funcA function specifying how the arrays length should be calculated from the dependees value.
Optika::NumberArrayLengthDependency::NumberArrayLengthDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  parentList,
int(*)(int)  func = 0 
)

Constructs an ArrayLengthDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
funcA function specifying how the arrays length should be calculated from the dependees value.
Optika::NumberArrayLengthDependency::NumberArrayLengthDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
ParameterParentMap  dependents,
int(*)(int)  func = 0 
)

Constructs an ArrayLengthDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
funcA function specifying how the arrays length should be calculated from the dependees value.

Member Function Documentation

void Optika::NumberArrayLengthDependency::evaluate ( ) [virtual]

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implements Optika::Dependency.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations