DynamicRestitutionStimulus Class Reference

#include <DynamicRestitutionStimulus.hpp>

Inheritance diagram for DynamicRestitutionStimulus:

Collaboration diagram for DynamicRestitutionStimulus:

List of all members.

Public Member Functions

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

Private Member Functions

template<class Archive>

void serialize (Archive &archive, const unsigned int version)

DynamicRestitutionStimulus ()

Friends

class boost::serialization::access

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.

DynamicRestitutionStimulus::DynamicRestitutionStimulus ( ) [inline, private]

Private constructor - for archiving's eyes only.

DynamicRestitutionStimulus::DynamicRestitutionStimulus	(	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

template<class Archive>

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

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

Parameters:

	archive
	version

Reimplemented from MultiStimulus.

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

Needed for serialization.

Reimplemented from MultiStimulus.

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


Public Member Functions
	DynamicRestitutionStimulus (double magnitude, double stimulusDuration, double startTime, std::vector< double > pacingCycleLengths, unsigned numberOfPulses)
Private Member Functions
template<class Archive>
void	serialize (Archive &archive, const unsigned int version)
	DynamicRestitutionStimulus ()
Friends
class	boost::serialization::access