ZeroStimulus Class Reference

#include <ZeroStimulus.hpp>

Inheritance diagram for ZeroStimulus:

Inheritance graph
[legend]
Collaboration diagram for ZeroStimulus:

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Stimulus which is always zero. More efficient than using an SimpleStimulus with magnitude zero

Definition at line 41 of file ZeroStimulus.hpp.


Member Function Documentation

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

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

Parameters:
archive 
version 

Reimplemented from AbstractStimulusFunction.

Definition at line 52 of file ZeroStimulus.hpp.

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

Returns the stimulus at a given time.

Parameters:
time time at which to return the stimulus

Implements AbstractStimulusFunction.

Definition at line 39 of file ZeroStimulus.cpp.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractStimulusFunction.

Definition at line 44 of file ZeroStimulus.hpp.


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

Generated on Mon Apr 18 11:38:08 2011 for Chaste by  doxygen 1.5.5