#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.

Constructor & Destructor Documentation

◆ ZeroStimulus()

ZeroStimulus::ZeroStimulus ( )

Definition at line 38 of file ZeroStimulus.cpp.

◆ ~ZeroStimulus()

ZeroStimulus::~ZeroStimulus ( )

virtual

Definition at line 42 of file ZeroStimulus.cpp.

Member Function Documentation

◆ GetStimulus()

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.

◆ serialize()

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 Symbol Documentation

◆ boost::serialization::access

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

Public Member Functions

Private Member Functions

Friends