SimpleStimulus Class Reference

#include <SimpleStimulus.hpp>

Inheritance diagram for SimpleStimulus:

Inheritance graph
[legend]
Collaboration diagram for SimpleStimulus:

Collaboration graph
[legend]

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 42 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 37 of file SimpleStimulus.cpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

SimpleStimulus::~SimpleStimulus (  )  [virtual]

Destructor.

Destructor

Definition at line 49 of file SimpleStimulus.cpp.


Member Function Documentation

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 53 of file SimpleStimulus.hpp.

References mDuration, mMagnitudeOfStimulus, and mTimeOfStimulus.

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 59 of file SimpleStimulus.cpp.

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 45 of file SimpleStimulus.hpp.


Member Data Documentation

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

Definition at line 67 of file SimpleStimulus.hpp.

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

double SimpleStimulus::mDuration [private]

Duration of initial stimulus, typically in milliseconds

Definition at line 69 of file SimpleStimulus.hpp.

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

The time at which the stimulus starts, typically in milliseconds

Definition at line 71 of file SimpleStimulus.hpp.

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


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

Generated on Mon Nov 1 12:37:22 2010 for Chaste by  doxygen 1.5.5