Chaste Release::3.1
RegularStimulusZeroNetCharge Class Reference

#include <RegularStimulusZeroNetCharge.hpp>

Inheritance diagram for RegularStimulusZeroNetCharge:
Collaboration diagram for RegularStimulusZeroNetCharge:

List of all members.

Public Member Functions

 RegularStimulusZeroNetCharge (double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX)
double GetStimulus (double time)

Private Member Functions

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

Friends

class boost::serialization::access

Detailed Description

Provides a periodic square-wave stimulus, where the total net charge is zero for every stimulus.

i.e., -------- | | | | -------- | ------------- | | | | --------

<------------> Duration

Definition at line 60 of file RegularStimulusZeroNetCharge.hpp.


Constructor & Destructor Documentation

RegularStimulusZeroNetCharge::RegularStimulusZeroNetCharge ( double  magnitudeOfStimulus,
double  duration,
double  period,
double  startTime,
double  stopTime = DBL_MAX 
)

Create a new stimulus.

Parameters:
magnitudeOfStimulusThe size of the stimulus, both positive and negative
durationHow long the stimulus is applied for (time positive + time negative)
periodThe time between square waves being applied
startTimeThe time at which the first wave is applied
stopTimeThe time the stimulus is removed (defaults to DBL_MAX if omitted)

Definition at line 40 of file RegularStimulusZeroNetCharge.cpp.


Member Function Documentation

double RegularStimulusZeroNetCharge::GetStimulus ( double  time) [virtual]

Get the magnitude of stimulus at time 'time'. Re-implemented from parent class RegulsrStimulus.

Parameters:
timeThe current time
Returns:
Magnitude of stimulus at time 'time'.

Reimplemented from RegularStimulus.

Definition at line 46 of file RegularStimulusZeroNetCharge.cpp.

References RegularStimulus::mDuration, RegularStimulus::mMagnitudeOfStimulus, RegularStimulus::mPeriod, RegularStimulus::mStartTime, and RegularStimulus::mStopTime.

template<class Archive >
void RegularStimulusZeroNetCharge::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

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

Parameters:
archive
version

Reimplemented from RegularStimulus.

Definition at line 72 of file RegularStimulusZeroNetCharge.hpp.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from RegularStimulus.

Definition at line 64 of file RegularStimulusZeroNetCharge.hpp.


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