RegularStimulusZeroNetCharge Class Reference

#include <RegularStimulusZeroNetCharge.hpp>

Inheritance diagram for RegularStimulusZeroNetCharge:

Collaboration diagram for RegularStimulusZeroNetCharge:

List of all members.

Public Member Functions

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

double GetStimulus (double time)

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, where the total net charge is zero for every stimulus.

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

<-----------> Duration

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)

template<class Archive>

void RegularStimulusZeroNetCharge::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

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

Parameters:

	archive
	version

Reimplemented from RegularStimulus.

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

Get the magnitude of stimulus at time 'time'. Re-implemented from parent class RegulsrStimulus.

Parameters:

time

The current time

Reimplemented from RegularStimulus.

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

Needed for serialization.

Reimplemented from RegularStimulus.

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


Public Member Functions
	RegularStimulusZeroNetCharge (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)
double	GetStimulus (double time)
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access