AnimatCarlSim::CsFiringRateStimulus Class Reference

Current stimulus for neural items. More...

#include <CsFiringRateStimulus.h>

Inheritance diagram for AnimatCarlSim::CsFiringRateStimulus:

Collaboration diagram for AnimatCarlSim::CsFiringRateStimulus:

Public Member Functions
	CsFiringRateStimulus ()
	Default constructor. More...
virtual	~CsFiringRateStimulus ()
	Destructor. More...
virtual void	Activate ()
virtual float	ActiveRate ()
virtual void	CellsToStim (std::string strXml)
virtual float	ConstantRate ()
virtual void	ConstantRate (float fltVal)
virtual void	Coverage (std::string strType)
virtual void	Deactivate ()
virtual std::string	Equation ()
	Gets the post-fix current equation string. If this is null then an equation is not used. If one is specified then that equation is used during the cycle on times. More...
virtual void	Equation (std::string strEquation)
	Sets the postfix current equation to use. If this is blank then the current constants (current on/off) are used. If it is not blank then this equation is used during the cycle on periods. More...
virtual float *	GetDataPointer (const std::string &strDataType)
virtual void	Initialize ()
virtual void	Load (CStdXml &oXml)
virtual float	PrevAppliedRate ()
virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
virtual bool	RateChanged ()
virtual void	ResetSimulation ()
virtual bool	SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
virtual void	StepSimulation ()
virtual bool	StimWholePopulation ()
virtual void	StimWholePopulation (bool bVal)
virtual std::string	TargetNodeID ()
	Gets the GUID ID of the node that is being stimulated. More...
virtual void	TargetNodeID (std::string strID)
	Sets the GUID ID of the node that will be stimulated. More...

Static Public Member Functions
static CsFiringRateStimulus *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions
virtual void	ApplyRateChange ()
virtual float	CalculateFiringRate ()
	Calculates the on cycle current at this time step. More...
virtual void	LoadCellsToStim (CStdXml &oXml)

Protected Attributes
CStdMap< int, int >	m_aryCellsToStim
	An array of neuron indices for individual neurons we want to stimulate.
bool	m_bStimWholePopulation
	Tells whether this stimulus is applied to the entire population or just individual cells.
float	m_fltActiveRate
	The currently active firing rate.
float	m_fltConstantRate
	The value to use for active rate if the type is constant.
float	m_fltPrevAppliedRate
	The previous active firing rate.
CStdPostFixEval *	m_lpEval
	Pointer to the post-fix equation evaluator.
CsSpikeGeneratorGroup *	m_lpSpikeGen
	The spike generator this object is stimulating.
std::string	m_strEquation
	The post-fix string current equation.
std::string	m_strTargetNodeID
	GUID ID of the neuron we are stimulating.

Detailed Description

Current stimulus for neural items.

Author

dcofer

Date

3/16/2011

Definition at line 20 of file CsFiringRateStimulus.h.

Constructor & Destructor Documentation

AnimatCarlSim::CsFiringRateStimulus::CsFiringRateStimulus

(

)

Default constructor.

Author

dcofer

Date

3/16/2011

Definition at line 23 of file CsFiringRateStimulus.cpp.

References m_bStimWholePopulation, m_fltActiveRate, m_fltConstantRate, m_fltPrevAppliedRate, m_lpEval, and m_lpSpikeGen.

AnimatCarlSim::CsFiringRateStimulus::~CsFiringRateStimulus ( )

virtual

Destructor.

Author

dcofer

Date

3/16/2011

Definition at line 40 of file CsFiringRateStimulus.cpp.

References m_lpEval, m_lpSpikeGen, and StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

float AnimatCarlSim::CsFiringRateStimulus::CalculateFiringRate ( )

protectedvirtual

Calculates the on cycle current at this time step.

Author

dcofer

Date

3/17/2011

Returns

The current on.

Definition at line 195 of file CsFiringRateStimulus.cpp.

References m_fltActiveRate, m_fltConstantRate, and m_lpEval.

std::string AnimatCarlSim::CsFiringRateStimulus::Equation ( )

virtual

Gets the post-fix current equation string. If this is null then an equation is not used. If one is specified then that equation is used during the cycle on times.

Author

dcofer

Date

3/17/2011

Returns

.

Definition at line 89 of file CsFiringRateStimulus.cpp.

References m_strEquation.

void AnimatCarlSim::CsFiringRateStimulus::Equation ( std::string  strEquation )

virtual

Sets the postfix current equation to use. If this is blank then the current constants (current on/off) are used. If it is not blank then this equation is used during the cycle on periods.

Author

dcofer

Date

3/17/2011

Parameters

strEquation

The post-fix string equation.

Definition at line 101 of file CsFiringRateStimulus.cpp.

References m_fltActiveRate, m_fltConstantRate, m_lpEval, m_strEquation, and StdUtils::Std_IsBlank().

Here is the call graph for this function:

std::string AnimatCarlSim::CsFiringRateStimulus::TargetNodeID ( )

virtual

Gets the GUID ID of the node that is being stimulated.

Author

dcofer

Date

3/17/2011

Returns

.

Definition at line 63 of file CsFiringRateStimulus.cpp.

References m_strTargetNodeID.

void AnimatCarlSim::CsFiringRateStimulus::TargetNodeID ( std::string  strID )

virtual

Sets the GUID ID of the node that will be stimulated.

Author

dcofer

Date

3/17/2011

Parameters

strID

Identifier for the string.

Definition at line 73 of file CsFiringRateStimulus.cpp.

References m_strTargetNodeID, and StdUtils::Std_IsBlank().

Here is the call graph for this function:

---

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

• CsFiringRateStimulus.h
• CsFiringRateStimulus.cpp