MultiStimulus Class Reference

#include <MultiStimulus.hpp>

Inheritance diagram for MultiStimulus:

Inheritance graph
[legend]
Collaboration diagram for MultiStimulus:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void AddStimulus (AbstractStimulusFunction *pStimulus)
double GetStimulus (double time)

Private Attributes

std::vector
< AbstractStimulusFunction * > 
mStimuli


Detailed Description

This class provides a stimulus function which is the sum of an arbitrary number of stimuli.

After creation it behaves like a ZeroStimulus until any number of stimuli are added.

Definition at line 44 of file MultiStimulus.hpp.


Member Function Documentation

void MultiStimulus::AddStimulus ( AbstractStimulusFunction pStimulus  ) 

Combine a stimulus with the existing ones.

Parameters:
pStimulus pointer to the stimulus to be added.

Definition at line 32 of file MultiStimulus.cpp.

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

Get the magnitude of the multiple stimuli at time 'time'

Returns:
Magnitude of stimulus at time 'time'.

Implements AbstractStimulusFunction.

Definition at line 37 of file MultiStimulus.cpp.


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

Generated on Wed Mar 18 12:52:44 2009 for Chaste by  doxygen 1.5.5