SimpleStimulus Class Reference
#include <SimpleStimulus.hpp>
Public Member Functions | |
| SimpleStimulus (double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0) | |
| virtual | ~SimpleStimulus () |
| double | GetStimulus (double time) |
Private Attributes | |
| double | mMagnitudeOfStimulus |
| double | mDuration |
| double | mTimeOfStimulus |
Detailed Description
Provides an simple stimulus of magnitude 'magnitudeOfStimulus' from time 'timeOfStimulus' for duration 'duration'.Definition at line 39 of file SimpleStimulus.hpp.
Constructor & Destructor Documentation
| SimpleStimulus::SimpleStimulus | ( | double | magnitudeOfStimulus, | |
| double | duration, | |||
| double | timeOfStimulus = 0.0 | |||
| ) |
Constructor
Definition at line 37 of file SimpleStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.
| SimpleStimulus::~SimpleStimulus | ( | ) | [virtual] |
Destructor
Definition at line 49 of file SimpleStimulus.cpp.
Member Function Documentation
| double SimpleStimulus::GetStimulus | ( | double | time | ) | [virtual] |
Get the magnitude of stimulus at time 'time'
- Returns:
- Magnitude of stimulus at time 'time'
Implements AbstractStimulusFunction.
Definition at line 59 of file SimpleStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.
Member Data Documentation
double SimpleStimulus::mMagnitudeOfStimulus [private] |
The stimulus magnitude, typically in microA/cm^2
Definition at line 43 of file SimpleStimulus.hpp.
Referenced by GetStimulus(), and SimpleStimulus().
double SimpleStimulus::mDuration [private] |
Duration of initial stimulus, typically in milliseconds
Definition at line 45 of file SimpleStimulus.hpp.
Referenced by GetStimulus(), and SimpleStimulus().
double SimpleStimulus::mTimeOfStimulus [private] |
The time at which the stimulus starts, typically in milliseconds
Definition at line 47 of file SimpleStimulus.hpp.
Referenced by GetStimulus(), and SimpleStimulus().
The documentation for this class was generated from the following files:
- /tmp/release_1/heart/src/stimulus/SimpleStimulus.hpp
- /tmp/release_1/heart/src/stimulus/SimpleStimulus.cpp
