RegularStimulus Class Reference

#include <RegularStimulus.hpp>

Inheritance diagram for RegularStimulus:

Inheritance graph
[legend]
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 SetPeriod (double period)
void SetStartTime (double startTime)
void SetStopTime (double stopTime)

Private Member Functions

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

Private Attributes

double mMagnitudeOfStimulus
double mDuration
double mPeriod
double mStartTime
double mStopTime

Friends

class boost::serialization::access


Detailed Description

Provides a periodic square-wave stimulus.

Definition at line 41 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 36 of file RegularStimulus.cpp.

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


Member Function Documentation

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.

Definition at line 53 of file RegularStimulus.hpp.

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

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.

Definition at line 51 of file RegularStimulus.cpp.

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

double RegularStimulus::GetPeriod (  ) 

Returns:
the pacing cycle length or period of the stimulus.

Definition at line 76 of file RegularStimulus.cpp.

References mPeriod.

double RegularStimulus::GetMagnitude (  ) 

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

Definition at line 81 of file RegularStimulus.cpp.

References mMagnitudeOfStimulus.

double RegularStimulus::GetDuration (  ) 

Returns:
the duration of the stimulus square wave.

Definition at line 86 of file RegularStimulus.cpp.

References mDuration.

double RegularStimulus::GetStartTime (  ) 

Returns:
the start time of the stimulus square wave.

Definition at line 91 of file RegularStimulus.cpp.

References mStartTime.

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 96 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 101 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 106 of file RegularStimulus.cpp.

References mStopTime.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractStimulusFunction.

Definition at line 45 of file RegularStimulus.hpp.


Member Data Documentation

The 'height' of the square wave applied

Definition at line 65 of file RegularStimulus.hpp.

Referenced by GetMagnitude(), GetStimulus(), RegularStimulus(), and serialize().

double RegularStimulus::mDuration [private]

The length of the square wave

Definition at line 67 of file RegularStimulus.hpp.

Referenced by GetDuration(), GetStimulus(), RegularStimulus(), and serialize().

double RegularStimulus::mPeriod [private]

The time between applications of the wave

Definition at line 69 of file RegularStimulus.hpp.

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

double RegularStimulus::mStartTime [private]

The time at which the first wave is applied

Definition at line 71 of file RegularStimulus.hpp.

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

double RegularStimulus::mStopTime [private]

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

Definition at line 73 of file RegularStimulus.hpp.

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


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

Generated on Mon Nov 1 12:37:18 2010 for Chaste by  doxygen 1.5.5