FixedModifier Class Reference

#include <Modifiers.hpp>

Inheritance diagram for FixedModifier:

Inheritance graph
[legend]
Collaboration diagram for FixedModifier:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FixedModifier (double value)
virtual double Calc (double param, double time)

Private Attributes

double mValue


Detailed Description

This class just returns a fixed value, regardless of the parameter's default or the time.

Definition at line 96 of file Modifiers.hpp.


Constructor & Destructor Documentation

FixedModifier::FixedModifier ( double  value  )  [inline]

Constructor

Parameters:
value The fixed value to use.

Definition at line 107 of file Modifiers.hpp.


Member Function Documentation

virtual double FixedModifier::Calc ( double  param,
double  time 
) [inline, virtual]

Perform the modification.

Parameters:
param the current value of the quantity which is being modified
time the current simulation time
Returns:
the fixed value (ignores inputs)

Implements AbstractModifier.

Definition at line 119 of file Modifiers.hpp.

References mValue.


Member Data Documentation

double FixedModifier::mValue [private]

Fixed value to clamp parameter at

Definition at line 100 of file Modifiers.hpp.

Referenced by Calc().


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

Generated on Mon Apr 18 11:37:08 2011 for Chaste by  doxygen 1.5.5