Chaste Release::3.1
Public Member Functions | Private Member Functions | Private Attributes | Friends
SimpleStimulus Class Reference

#include <SimpleStimulus.hpp>

Inheritance diagram for SimpleStimulus:
Collaboration diagram for SimpleStimulus:

List of all members.

Public Member Functions

 SimpleStimulus (double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0)
virtual ~SimpleStimulus ()
double GetStimulus (double time)

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:
magnitudeOfStimulusThe stimulus magnitude, with units for single-cell problems - microA/cm^2 for (3d) tissue simulations - microA/cm^3
durationDuration of initial stimulus milliseconds
timeOfStimulusThe 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:
timetime 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 
) [inline, private]

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

Parameters:
archive
version

Reimplemented from AbstractStimulusFunction.

Definition at line 60 of file SimpleStimulus.hpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractStimulusFunction.

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(), and SimpleStimulus().

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