ZeroStimulus Class Reference

#include <ZeroStimulus.hpp>

Inheritance diagram for ZeroStimulus:

Collaboration diagram for ZeroStimulus:

Public Member Functions
double	GetStimulus (double time)
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)

Friends
class	boost::serialization::access

Detailed Description

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

Definition at line 48 of file ZeroStimulus.hpp.

Member Function Documentation

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 46 of file ZeroStimulus.cpp.

template<class Archive >

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

inlineprivate

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

Parameters

archive
version

Definition at line 59 of file ZeroStimulus.hpp.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 51 of file ZeroStimulus.hpp.

---

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

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