![]() |
Chaste Commit::333233612e3dcc941d260418acd7b5ccdc30390e
|
#include <SimpleStimulus.hpp>
Public Member Functions | |
SimpleStimulus (double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0) | |
virtual | ~SimpleStimulus () |
double | GetStimulus (double time) |
void | SetStartTime (double startTime) |
![]() | |
virtual | ~AbstractStimulusFunction () |
virtual void | Clear () |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
double | mMagnitudeOfStimulus |
double | mDuration |
double | mTimeOfStimulus |
Friends | |
class | boost::serialization::access |
Provides an simple stimulus of magnitude 'magnitudeOfStimulus' from time 'timeOfStimulus' for duration 'duration'.
Definition at line 49 of file SimpleStimulus.hpp.
SimpleStimulus::SimpleStimulus | ( | double | magnitudeOfStimulus, |
double | duration, | ||
double | timeOfStimulus = 0.0 |
||
) |
Constructor.
magnitudeOfStimulus | The stimulus magnitude, with units for single-cell problems - microA/cm^2 for (3d) tissue simulations - microA/cm^3 |
duration | Duration of initial stimulus milliseconds |
timeOfStimulus | The time at which the stimulus starts (defaults to 0.0) milliseconds |
Constructor
Definition at line 44 of file SimpleStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.
|
virtual |
Returns the stimulus at a given time.
time | time at which to return the stimulus |
Get the magnitude of stimulus at time 'time'
Implements AbstractStimulusFunction.
Definition at line 66 of file SimpleStimulus.cpp.
References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.
|
inlineprivate |
Archive the simple stimulus, never used directly - boost uses this.
archive | |
version |
Definition at line 60 of file SimpleStimulus.hpp.
References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.
void SimpleStimulus::SetStartTime | ( | double | startTime | ) |
Replace the time that was specified in the constructor with a new start time.
startTime |
Definition at line 78 of file SimpleStimulus.cpp.
References mTimeOfStimulus.
|
friend |
Needed for serialization.
Definition at line 52 of file SimpleStimulus.hpp.
|
private |
Duration of initial stimulus, typically in milliseconds
Definition at line 76 of file SimpleStimulus.hpp.
Referenced by SimpleStimulus(), GetStimulus(), and serialize().
|
private |
The stimulus magnitude - units are: for single-cell problems - microA/cm^2 for (3d) tissue simulations - microA/cm^3
Definition at line 74 of file SimpleStimulus.hpp.
Referenced by SimpleStimulus(), GetStimulus(), and serialize().
|
private |
The time at which the stimulus starts, typically in milliseconds
Definition at line 78 of file SimpleStimulus.hpp.
Referenced by SimpleStimulus(), GetStimulus(), serialize(), and SetStartTime().