RegularStimulus Class Reference

#include <RegularStimulus.hpp>

Inherits AbstractStimulusFunction.

Inherited by RegularStimulusZeroNetCharge.

Collaboration diagram for RegularStimulus:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 RegularStimulus (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)
double GetStimulus (double time)
double GetPeriod ()
double GetMagnitude ()
double GetDuration ()
double GetStartTime ()
void SetMagnitude (double magnitude)
void SetPeriod (double period)
void SetDuration (double duration)
void SetStartTime (double startTime)
void SetStopTime (double stopTime)

Protected Attributes

double mMagnitudeOfStimulus
double mDuration
double mPeriod
double mStartTime
double mStopTime

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)

Friends

class boost::serialization::access

Detailed Description

Provides a periodic square-wave stimulus.

Definition at line 48 of file RegularStimulus.hpp.

Constructor & Destructor Documentation

RegularStimulus::RegularStimulus ( double  magnitudeOfStimulus,
double  duration,
double  period,
double  startTime,
double  stopTime = DBL_MAX 
)

Create a new stimulus.

Parameters:
magnitudeOfStimulus The size of the stimulus
duration How long the square wave is applied for
period The time between square waves being applied
startTime The time at which the first wave is applied
stopTime The time the stimulus is removed (defaults to DBL_MAX if omitted)

Definition at line 43 of file RegularStimulus.cpp.

References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.

Member Function Documentation

double RegularStimulus::GetDuration (  ) 
Returns:
the duration of the stimulus square wave.

Definition at line 93 of file RegularStimulus.cpp.

References mDuration.

double RegularStimulus::GetMagnitude (  ) 
Returns:
the height of the stimulus square wave (magnitude of current).

Definition at line 88 of file RegularStimulus.cpp.

References mMagnitudeOfStimulus.

double RegularStimulus::GetPeriod (  ) 
Returns:
the pacing cycle length or period of the stimulus.

Definition at line 83 of file RegularStimulus.cpp.

References mPeriod.

double RegularStimulus::GetStartTime (  ) 
Returns:
the start time of the stimulus square wave.

Definition at line 98 of file RegularStimulus.cpp.

References mStartTime.

double RegularStimulus::GetStimulus ( double  time  )  [virtual]

Get the magnitude of stimulus at time 'time'

Parameters:
time The current time
Returns:
Magnitude of stimulus

Implements AbstractStimulusFunction.

Reimplemented in RegularStimulusZeroNetCharge.

Definition at line 58 of file RegularStimulus.cpp.

References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.

template<class Archive >
void RegularStimulus::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the simple stimulus, never used directly - boost uses this.

Parameters:
archive 
version 

Reimplemented from AbstractStimulusFunction.

Reimplemented in RegularStimulusZeroNetCharge.

Definition at line 60 of file RegularStimulus.hpp.

References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and mStopTime.

void RegularStimulus::SetDuration ( double  duration  ) 

set the length ('duration') of the stimulus square wave.

Parameters:
duration The stimulus duration to use.

Definition at line 113 of file RegularStimulus.cpp.

References mDuration.

void RegularStimulus::SetMagnitude ( double  magnitude  ) 

Set the magnitude of the stimulus to apply. Takes units of uA/cm^2 in single cell simulations or uA/cm^3 in tissue simulations

See https://chaste.cs.ox.ac.uk/trac/wiki/ChasteGuides/ChasteUnits for a full discussion of this.

Parameters:
magnitude The magnitude of stimulus to apply.

Definition at line 103 of file RegularStimulus.cpp.

References mMagnitudeOfStimulus.

void RegularStimulus::SetPeriod ( double  period  ) 

set the pacing cycle length ('period') of the stimulus.

Parameters:
period The stimulus pacing cycle length to use.

Definition at line 108 of file RegularStimulus.cpp.

References mPeriod.

void RegularStimulus::SetStartTime ( double  startTime  ) 

Set the stimulus to start at a particular time.

Parameters:
startTime the time the stimulus should begin.

Definition at line 118 of file RegularStimulus.cpp.

References mStartTime.

void RegularStimulus::SetStopTime ( double  stopTime  ) 

Set the stop time for this stimulus. It will never be applied after this time.

Parameters:
stopTime 

Definition at line 123 of file RegularStimulus.cpp.

References mStopTime.

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractStimulusFunction.

Reimplemented in RegularStimulusZeroNetCharge.

Definition at line 52 of file RegularStimulus.hpp.

Member Data Documentation

double RegularStimulus::mDuration [protected]

The length of the square wave

Definition at line 76 of file RegularStimulus.hpp.

Referenced by GetDuration(), RegularStimulusZeroNetCharge::GetStimulus(), GetStimulus(), RegularStimulus(), serialize(), and SetDuration().

double RegularStimulus::mMagnitudeOfStimulus [protected]

The 'height' of the square wave applied

Definition at line 74 of file RegularStimulus.hpp.

Referenced by GetMagnitude(), RegularStimulusZeroNetCharge::GetStimulus(), GetStimulus(), RegularStimulus(), serialize(), and SetMagnitude().

double RegularStimulus::mPeriod [protected]

The time between applications of the wave

Definition at line 78 of file RegularStimulus.hpp.

Referenced by GetPeriod(), RegularStimulusZeroNetCharge::GetStimulus(), GetStimulus(), RegularStimulus(), serialize(), and SetPeriod().

double RegularStimulus::mStartTime [protected]

The time at which the first wave is applied

Definition at line 80 of file RegularStimulus.hpp.

Referenced by GetStartTime(), RegularStimulusZeroNetCharge::GetStimulus(), GetStimulus(), RegularStimulus(), serialize(), and SetStartTime().

double RegularStimulus::mStopTime [protected]

The time at which all stimuli are removed (even if halfway through a wave)

Definition at line 82 of file RegularStimulus.hpp.

Referenced by RegularStimulusZeroNetCharge::GetStimulus(), GetStimulus(), RegularStimulus(), serialize(), and SetStopTime().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2