DynamicRestitutionStimulus Class Reference

#include <DynamicRestitutionStimulus.hpp>

Inheritance diagram for DynamicRestitutionStimulus:

Inheritance graph
[legend]
Collaboration diagram for DynamicRestitutionStimulus:

Collaboration graph
[legend]

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.

Definition at line 46 of file DynamicRestitutionStimulus.hpp.


Constructor & Destructor Documentation

DynamicRestitutionStimulus::DynamicRestitutionStimulus (  )  [inline, private]

Private constructor - for archiving's eyes only.

Definition at line 67 of file DynamicRestitutionStimulus.hpp.

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

Definition at line 31 of file DynamicRestitutionStimulus.cpp.

References MultiStimulus::AddStimulus().


Member Function Documentation

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.

Definition at line 58 of file DynamicRestitutionStimulus.hpp.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from MultiStimulus.

Definition at line 50 of file DynamicRestitutionStimulus.hpp.


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

Generated on Tue May 31 14:33:22 2011 for Chaste by  doxygen 1.5.5