AbstractStimulusFunction Class Reference

#include <AbstractStimulusFunction.hpp>

Inheritance diagram for AbstractStimulusFunction:

[legend]

List of all members.

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

Represents an abstract stimulus function. Sub-classes will implement the GetStimulus() function to represent the various type of stimuli to the cardiac cell.

Definition at line 47 of file AbstractStimulusFunction.hpp.

---

Constructor & Destructor Documentation

virtual AbstractStimulusFunction::~AbstractStimulusFunction

(

)

[inline, virtual]

Destructor.

Definition at line 74 of file AbstractStimulusFunction.hpp.

---

Member Function Documentation

template<class Archive>

void AbstractStimulusFunction::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Archive the member variables.

Parameters:

	archive
	version

Reimplemented in MultiStimulus, RegularStimulus, SimpleStimulus, and ZeroStimulus.

Definition at line 58 of file AbstractStimulusFunction.hpp.

virtual double AbstractStimulusFunction::GetStimulus

(

double

time

)

[pure virtual]

Returns the stimulus at a given time.

Parameters:

time

time at which to return the stimulus

Implemented in MultiStimulus, RegularStimulus, SimpleStimulus, and ZeroStimulus.

Referenced by StimulusBoundaryCondition< SPACE_DIM >::GetValue().

virtual void AbstractStimulusFunction::Clear

(

)

[inline, virtual]

Clear is used to managed memory in subclasses where the destructor may or may not need to clean up.

Reimplemented in MultiStimulus.

Definition at line 80 of file AbstractStimulusFunction.hpp.

---

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented in MultiStimulus, RegularStimulus, SimpleStimulus, and ZeroStimulus.

Definition at line 50 of file AbstractStimulusFunction.hpp.

---

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

• /tmp/release_1.1/heart/src/stimulus/AbstractStimulusFunction.hpp