SimpleStimulus Class Reference

#include <SimpleStimulus.hpp>

Inheritance diagram for SimpleStimulus:

Collaboration diagram for SimpleStimulus:

Public Member Functions
	SimpleStimulus (double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0)
virtual	~SimpleStimulus ()
double	GetStimulus (double time)
void	SetStartTime (double startTime)
Public Member Functions inherited from AbstractStimulusFunction
virtual	~AbstractStimulusFunction ()
virtual void	Clear ()

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

Private Attributes
double	mMagnitudeOfStimulus
double	mDuration
double	mTimeOfStimulus

Friends
class	boost::serialization::access

Detailed Description

Provides an simple stimulus of magnitude 'magnitudeOfStimulus' from time 'timeOfStimulus' for duration 'duration'.

Definition at line 49 of file SimpleStimulus.hpp.

Constructor & Destructor Documentation

SimpleStimulus::SimpleStimulus	(	double	magnitudeOfStimulus,
		double	duration,
		double	timeOfStimulus = 0.0
	)

Constructor.

Parameters

magnitudeOfStimulus	The stimulus magnitude, with units for single-cell problems - microA/cm^2 for (3d) tissue simulations - microA/cm^3
duration	Duration of initial stimulus milliseconds
timeOfStimulus	The time at which the stimulus starts (defaults to 0.0) milliseconds

Constructor

Definition at line 44 of file SimpleStimulus.cpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

SimpleStimulus::~SimpleStimulus ( )

virtual

Destructor.

Destructor

Definition at line 56 of file SimpleStimulus.cpp.

Member Function Documentation

double SimpleStimulus::GetStimulus ( double  time )

virtual

Returns the stimulus at a given time.

Parameters

time	time at which to return the stimulus

Get the magnitude of stimulus at time 'time'

Returns

Magnitude of stimulus at time 'time'

Implements AbstractStimulusFunction.

Definition at line 66 of file SimpleStimulus.cpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

template<class Archive >

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

inlineprivate

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

Parameters

archive
version

Definition at line 60 of file SimpleStimulus.hpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

void SimpleStimulus::SetStartTime

(

double

startTime

)

Replace the time that was specified in the constructor with a new start time.

Parameters

startTime

Definition at line 78 of file SimpleStimulus.cpp.

References CHASTE_CLASS_EXPORT, and mTimeOfStimulus.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 52 of file SimpleStimulus.hpp.

Member Data Documentation

double SimpleStimulus::mDuration

private

Duration of initial stimulus, typically in milliseconds

Definition at line 76 of file SimpleStimulus.hpp.

Referenced by GetStimulus(), serialize(), and SimpleStimulus().

double SimpleStimulus::mMagnitudeOfStimulus

private

The stimulus magnitude - units are: for single-cell problems - microA/cm^2 for (3d) tissue simulations - microA/cm^3

Definition at line 74 of file SimpleStimulus.hpp.

Referenced by GetStimulus(), serialize(), and SimpleStimulus().

double SimpleStimulus::mTimeOfStimulus

private

The time at which the stimulus starts, typically in milliseconds

Definition at line 78 of file SimpleStimulus.hpp.

Referenced by GetStimulus(), serialize(), SetStartTime(), and SimpleStimulus().

---

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

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