Inheritance diagram for SteadyStateRestitutionStimulus:

Collaboration diagram for SteadyStateRestitutionStimulus:

Public Member Functions
	SteadyStateRestitutionStimulus (double magnitude, double stimulusDuration, double startTime, std::vector< double > pacingCycleLengths, unsigned numberOfPulses)

Public Member Functions inherited from MultiStimulus
	~MultiStimulus ()

void	AddStimulus (boost::shared_ptr< AbstractStimulusFunction > pStimulus)

virtual double	GetStimulus (double time)

void	Clear ()

Public Member Functions inherited from AbstractStimulusFunction
virtual	~AbstractStimulusFunction ()

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

	SteadyStateRestitutionStimulus ()

Additional Inherited Members
Protected Attributes inherited from MultiStimulus
std::vector< boost::shared_ptr< AbstractStimulusFunction > >	mStimuli

Detailed Description

This class provides a stimulus function which follows a dynamic restitution protocol. i.e.

Run a RegularStimulus at certain frequencies for a certain number of pulses. These are combined into a MultiStimulus.

Constructor & Destructor Documentation

SteadyStateRestitutionStimulus::SteadyStateRestitutionStimulus ( )

inlineprivate

Private constructor - for archiving's eyes only.

SteadyStateRestitutionStimulus::SteadyStateRestitutionStimulus	(	double	magnitude,
		double	stimulusDuration,
		double	startTime,
		std::vector< double >	pacingCycleLengths,
		unsigned	numberOfPulses
	)

Constructor

Parameters

magnitude	The magnitude of the stimulus 'square wave'.
stimulusDuration	The duration of the stimulus 'square wave'.
startTime	The time at which to begin the S1 stimulus (this delay is automatically added to give smooth transition to S2).
pacingCycleLengths	A vector containing the pacing cycle lengths (in ms) of each phase of the protocol
numberOfPulses	The number of pulses to perform at each pacing cycle length