RegularStimulus Class Reference

#include <RegularStimulus.hpp>

Inherits AbstractStimulusFunction.

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)
 ~RegularStimulus ()
double GetStimulus (double time)

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 
)

Constructor for RegularStimulus

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.

RegularStimulus::~RegularStimulus (  ) 

Destructor

Definition at line 61 of file RegularStimulus.cpp.

Member Function Documentation

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 72 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.

Definition at line 53 of file RegularStimulus.hpp.

References mDuration, mMagnitudeOfStimulus, mPeriod, mStartTime, and 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

double RegularStimulus::mDuration [private]

The length of the square wave

Definition at line 67 of file RegularStimulus.hpp.

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

double RegularStimulus::mMagnitudeOfStimulus [private]

The 'height' of the square wave applied

Definition at line 65 of file RegularStimulus.hpp.

Referenced by 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 GetStimulus(), RegularStimulus(), and serialize().

double RegularStimulus::mStartTime [private]

The time at which the first wave is applied

Definition at line 71 of file RegularStimulus.hpp.

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

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(), and serialize().

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