Inheritance diagram for RegularStimulusZeroNetCharge:

Collaboration diagram for RegularStimulusZeroNetCharge:

Public Member Functions
	RegularStimulusZeroNetCharge (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)

double	GetStimulus (double time)

Public Member Functions inherited from RegularStimulus
	RegularStimulus (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)

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)

Public Member Functions inherited from AbstractStimulusFunction
virtual	~AbstractStimulusFunction ()

virtual void	Clear ()

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

Additional Inherited Members
Protected Attributes inherited from RegularStimulus
double	mMagnitudeOfStimulus

double	mDuration

double	mPeriod

double	mStartTime

double	mStopTime

Detailed Description

Provides a periodic square-wave stimulus, where the total net charge is zero for every stimulus.

i.e., -------- | | | | -------- | ------------- | | | | --------

<————> Duration

Constructor & Destructor Documentation

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

Create a new stimulus.

Parameters

magnitudeOfStimulus	The size of the stimulus, both positive and negative
duration	How long the stimulus is applied for (time positive + time negative)
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)