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:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependentName The name of the dependent parameter.
dependentParentList The ParameterList containing the dependent.
func A 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:
dependeeName The name of the dependee parameter.
dependentName The name of the dependent parameter.
parentList The ParameterList containing the dependent and the dependee.
func A 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:
dependeeName The name of the dependee parameter.
dependeeParentList The ParameterList containing the dependee.
dependents A map containing dependent Parameters associated with their paraent ParameterLists.
func A 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
Generated on Wed Apr 13 10:05:55 2011 for Optika by  doxygen 1.6.3