RegularStimulusZeroNetCharge Class Reference

#include <RegularStimulusZeroNetCharge.hpp>

Inherits RegularStimulus.

Collaboration diagram for RegularStimulusZeroNetCharge:

[legend]

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

Definition at line 53 of file RegularStimulusZeroNetCharge.hpp.

---

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)

Definition at line 33 of file RegularStimulusZeroNetCharge.cpp.

---

Member Function Documentation

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

Returns:

Magnitude of stimulus at time 'time'.

Reimplemented from RegularStimulus.

Definition at line 39 of file RegularStimulusZeroNetCharge.cpp.

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

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.

Definition at line 65 of file RegularStimulusZeroNetCharge.hpp.

---

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from RegularStimulus.

Definition at line 57 of file RegularStimulusZeroNetCharge.hpp.

---

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

• heart/src/stimulus/RegularStimulusZeroNetCharge.hpp
• heart/src/stimulus/RegularStimulusZeroNetCharge.cpp