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 (boost::shared_ptr< AbstractStimulusFunction > pStimulus)
double GetStimulus (double time)
void Clear ()

Private Member Functions

template<class Archive>
void serialize (Archive &archive, const unsigned int version)

Private Attributes

std::vector< boost::shared_ptr
< AbstractStimulusFunction > > 
mStimuli

Friends

class boost::serialization::access


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 56 of file MultiStimulus.hpp.


Member Function Documentation

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

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

Parameters:
archive 
version 

Reimplemented from AbstractStimulusFunction.

Definition at line 68 of file MultiStimulus.hpp.

References mStimuli.

void MultiStimulus::AddStimulus ( boost::shared_ptr< 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.

References mStimuli.

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

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

Parameters:
time time at which to return the stimulus
Returns:
Magnitude of stimulus at time 'time'.

Implements AbstractStimulusFunction.

Definition at line 37 of file MultiStimulus.cpp.

References mStimuli.

void MultiStimulus::Clear (  )  [virtual]

Clear is responsible for managing the memory of delegated stimuli

Reimplemented from AbstractStimulusFunction.

Definition at line 49 of file MultiStimulus.cpp.

References mStimuli.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractStimulusFunction.

Definition at line 60 of file MultiStimulus.hpp.


Member Data Documentation

std::vector<boost::shared_ptr<AbstractStimulusFunction> > MultiStimulus::mStimuli [private]

Vector of stimuli.

Definition at line 76 of file MultiStimulus.hpp.

Referenced by AddStimulus(), Clear(), GetStimulus(), and serialize().


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

Generated on Tue Aug 4 16:11:32 2009 for Chaste by  doxygen 1.5.5