Current stimulus for neural items. More...

#include <CurrentStimulus.h>

Inheritance diagram for AnimatSim::ExternalStimuli::CurrentStimulus:

Collaboration diagram for AnimatSim::ExternalStimuli::CurrentStimulus:

Public Member Functions
	CurrentStimulus ()
	Default constructor. More...

virtual	~CurrentStimulus ()
	Destructor. More...

virtual void	Activate ()
	Activates this item. More...

virtual void	AlwaysActive (bool bVal)
	Sets whether this item is always active. More...

virtual float	BurstOffDuration ()
	Gets the off burst current duration in time. More...

virtual void	BurstOffDuration (float fltVal)
	Sets the off burst duration value in time. More...

virtual float	BurstOnDuration ()
	Gets the on burst current duration in time. More...

virtual void	BurstOnDuration (float fltVal)
	Sets the on burst duration value in time. More...

virtual float	CurrentBurstOff ()
	Gets the off burst current value. More...

virtual void	CurrentBurstOff (float fltVal)
	Sets the of burst current value. More...

virtual std::string	CurrentEquation ()
	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	CurrentEquation (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	CurrentOff ()
	Gets the ffn cycle current value. More...

virtual void	CurrentOff (float fltVal)
	Sets the off cycle current value. More...

virtual float	CurrentOn ()
	Gets the on cycle current value. More...

virtual void	CurrentOn (float fltVal)
	Sets the on cycle current value. More...

virtual float	CycleOffDuration ()
	Gets the off cycle current duration in time. More...

virtual void	CycleOffDuration (float fltVal)
	Sets the off cycle duration value in time. More...

virtual float	CycleOnDuration ()
	Gets the on cycle current duration in time. More...

virtual void	CycleOnDuration (float fltVal)
	Sets the on cycle duration value in time. More...

virtual void	Deactivate ()
	Deactivates this item. More...

virtual float *	GetDataPointer (const std::string &strDataType)
	Returns a float pointer to a data item of interest in this object. More...

virtual void	Initialize ()
	Initializes this object. More...

virtual void	Load (CStdXml &oXml)

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. More...

virtual void	ResetSimulation ()
	Resets the simulation back to time 0. More...

virtual bool	SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual void	StepSimulation ()
	Step the simulation for this object. More...

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

virtual std::string	Type ()
	Gets the integer value of current type. This is (Constant, repetitive, and bursting) More...

virtual void	Type (std::string strValue)
	Sets the class type for this object. More...

Public Member Functions inherited from AnimatSim::ExternalStimuli::ExternalStimulus
	ExternalStimulus ()
	Default constructor. More...

virtual	~ExternalStimulus ()
	Destructor. More...

virtual bool	operator< (ActivatedItem *lpItem)
	Less-than comparison operator. More...

Public Member Functions inherited from AnimatSim::ActivatedItem
	ActivatedItem ()
	Default constructor. More...

virtual	~ActivatedItem ()
	Destructor. More...

virtual bool	AlwaysActive ()
	Gets whether this item is always active. More...

virtual bool	Enabled ()
	Gets whether the item is enabled or not. More...

virtual void	Enabled (bool bVal)
	Enables the item. More...

virtual long	EndSlice ()
	Gets the end time slice for deactivation. More...

virtual void	EndSlice (long lVal, bool bReInit=true)

virtual float	EndTime ()
	Gets the end simulation time for deactivation. More...

virtual void	EndTime (float fltVal, bool bReInit=true)

bool	IsActivated ()
	Query if this object is activated. More...

bool	IsInitialized ()
	Query if this object is initialized. More...

virtual bool	LoadedTime ()
	Gets whether time was loaded or time slices. More...

virtual void	LoadedTime (bool bVal)
	Sets whether time was loaded. More...

bool	NeedToActivate ()
	Determines if this item needs to be activated. More...

bool	NeedToDeactivate ()
	Determines if this item needs to be deactivated. More...

virtual bool	NeedToStep ()
	Tells if this item needs to call StepSimulation or not. More...

virtual bool	Overlaps (ActivatedItem *lpItem)
	Query if this object overlaps the time period for another ActivatedItem. More...

virtual void	ReInitialize ()
	Re-initialize this object. More...

virtual long	StartSlice ()
	Returns the starts slice for activation. More...

virtual void	StartSlice (long lVal, bool bReInit=true)

virtual float	StartTime ()
	Gets the simulation start time for activation. More...

virtual void	StartTime (float fltVal, bool bReInit=true)

virtual int	StepInterval ()
	Gets the step interval. More...

virtual void	StepInterval (int iVal)
	Sets the step interval. More...

virtual int	StepIntervalCount ()
	Gets the step interval count. More...

virtual void	StepIntervalCount (int iVal)
	Step interval count. More...

virtual void	TimeStepModified ()
	Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More...

Public Member Functions inherited from AnimatSim::AnimatBase
	AnimatBase ()
	Constructs an AnimatBase object. More...

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. More...

virtual bool	AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false)
	Adds a new object to this parent. More...

virtual void	AfterResetSimulation ()
	Called after a simulation reset for some objects. More...

virtual long	CalculateSnapshotByteSize ()
	Calculates the snapshot byte size. More...

virtual void	Copy (CStdSerialize *lpSource)

virtual NeuralModule *	GetNeuralModule ()
	Gets the neural module. More...

virtual Node *	GetNode ()
	Gets the node. More...

virtual Simulator *	GetSimulator ()
	Gets the simulator pointer. More...

virtual Structure *	GetStructure ()
	Gets the structure for this node. More...

virtual bool	HasProperty (const std::string &strName)
	Queries this object if it has a property with the given name. More...

virtual std::string	ID ()
	Gets the unique GUID ID of this object. More...

virtual void	ID (std::string strValue)
	Sets the unique GUID ID of the object. More...

virtual void	Kill (bool bState=true)
	Kills. More...

virtual void	Load (StdUtils::CStdXml &oXml)
	Loads the item using an XML data packet. More...

virtual void	LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Loads a key frame snapshot. More...

virtual std::string	Name ()
	Gets the name of this object. More...

virtual void	Name (std::string strValue)
	Sets the name of the object. Blank is acceptable. More...

virtual AnimatPropertyType	PropertyType (const std::string &strName)

virtual bool	RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
	Removes a child item from this parent. More...

virtual void	Reset ()
	Resets this object. More...

virtual void	RigidBodyAdded (std::string strID)

virtual void	RigidBodyRemoved (std::string strID)

virtual void	SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Saves a key frame snapshot. More...

virtual bool	Selected ()
	Tells if this items is selected or not. More...

virtual void	Selected (bool bValue, bool bSelectMultiple)
	Selects this object. More...

virtual bool	SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual bool	SetData (const std::string &strDataType, const long lValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual void	SetSystemPointers (Simulator lpSim, Structure lpStructure, NeuralModule lpModule, Node lpNode, bool bVerify)
	Sets the system pointers. More...

virtual void	SimPausing ()
	Called just before the simulation pauses. More...

virtual void	SimStarting ()
	Called just before the simulation starts. More...

virtual void	SimStopping ()
	Called just before the simulation stops. More...

virtual void	VerifySystemPointers ()
	Verify that system pointers have been set correctly. More...

virtual void	VisualSelectionModeChanged (int iNewMode)
	Visual selection mode changed. More...

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

Static Public Member Functions inherited from AnimatSim::ExternalStimuli::ExternalStimulus
static ExternalStimulus *	CastToDerived (AnimatBase *lpBase)

Static Public Member Functions inherited from AnimatSim::ActivatedItem
static ActivatedItem *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions
virtual float	GetCurrentOn ()
	Calculates the on cycle current at this time step. More...

virtual void	SetSliceData ()

Protected Attributes
bool	m_bBurstOn
	Tells whether a burst is on or not.

bool	m_bCycleOn
	Tells whether a cycle is on or not.

float	m_fltActiveCurrent
	The active current at that time step.

float	m_fltBurstOffDuration
	Duration of the burst off period in time.

float	m_fltBurstOnDuration
	Duration of the burst on period in time.

float	m_fltCurrentBurstOff
	The current to apply when the burst is off.

float	m_fltCurrentOff
	The current to apply when the cycle is off.

float	m_fltCurrentOn
	The current to apply when the cycle is on.

float	m_fltCycleOffDuration
	Duration of the cycle off period in time.

float	m_fltCycleOnDuration
	Duration of the cycle on period in time.

float	m_fltInitialActiveCurrent
	The initial active current that is used when reseting the simulation.

int	m_iType
	Tells the type of current to apply. (Constant, Repetitive, Bursting)

long	m_lBurstOffDuration
	Duration of the burst off period in time slices.

long	m_lBurstOnDuration
	Duration of the burst on period in time slices.

long	m_lBurstStart
	The time slice where the burst starts.

long	m_lCycleOffDuration
	Duration of the cycle off period in time slices.

long	m_lCycleOnDuration
	Duration of the cycle on period in time slices.

long	m_lCycleStart
	The time slice where the cycle starts.

CStdPostFixEval *	m_lpCurrentOnEval
	Pointer to the post-fix equation evaluator.

float *	m_lpExternalCurrent

std::string	m_strCurrentEquation
	The post-fix string current equation.

std::string	m_strTargetNodeID
	GUID ID of the neuron we are stimulating.

Protected Attributes inherited from AnimatSim::ActivatedItem
bool	m_bAlwaysActive
	Determines whether this item is always active during simulation.

bool	m_bInitialized
	true if item has been initialized

bool	m_bIsActivated
	true if item has been activated

bool	m_bLoadedTime

float	m_fltEndTime

float	m_fltStartTime

int	m_iStepInterval

int	m_iStepIntervalCount
	Keeps track of how many time steps have occured since it was zeroed again.

long	m_lEndSlice
	The time slice where this item is deactived.

long	m_lStartSlice
	The time slice where this item becomes active.

Protected Attributes inherited from AnimatSim::AnimatBase
bool	m_bEnabled
	Tells if this item is enabled or not. If it is not enabled then it is not run.

bool	m_bSelected
	Tells whether the object is selected or not.

AnimatSim::Behavior::NeuralModule *	m_lpModule
	The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.

Node *	m_lpNode
	The pointer to this items parent Node. If this is not relevant for this object then this is NULL.

Simulator *	m_lpSim
	The pointer to a Simulation.

AnimatSim::Environment::Structure *	m_lpStructure
	The pointer to this items parent Structure. If this is not relevant for this object then this is NULL.

std::string	m_strID
	The unique Id for this object.

std::string	m_strName
	The name for this object.

std::string	m_strType
	The type for this object. Examples are Box, Plane, Neuron, etc..

Detailed Description

Current stimulus for neural items.

This stimulus applies a current stimulus to a neuron type of Node object. It can be configured to apply either a constant, repetitive, or bursting stimulus type. A bursting stimulus is one that has a repetitive stimulus that occurs in bursts. This works by setting the cycle on/cycle off duration to set the time periods for repetitive stimuli, and burst on/off for the burst periods. If you want to do a constant current then cycle on/off and burst on/off should be the start/end times of the stimulus. If you want a repetitive current then set burst on/off to the start/end time of the stimulus, but set the cycle on/off to some other values in between. If you want bursting then set cycle on/off to values less than the burst on/off values.

Author: dcofer

Date: 3/16/2011

Definition at line 29 of file CurrentStimulus.h.

Constructor & Destructor Documentation

AnimatSim::ExternalStimuli::CurrentStimulus::CurrentStimulus ( )

Default constructor.

Author: dcofer

Date: 3/16/2011

Definition at line 54 of file CurrentStimulus.cpp.

References m_bBurstOn, m_bCycleOn, m_fltActiveCurrent, m_fltBurstOffDuration, m_fltBurstOnDuration, m_fltCurrentBurstOff, m_fltCurrentOff, m_fltCurrentOn, m_fltCycleOffDuration, m_fltCycleOnDuration, m_fltInitialActiveCurrent, m_iType, m_lBurstOffDuration, m_lBurstOnDuration, m_lBurstStart, m_lCycleOffDuration, m_lCycleOnDuration, m_lCycleStart, m_lpCurrentOnEval, m_lpExternalCurrent, and AnimatSim::AnimatBase::m_lpNode.

AnimatSim::ExternalStimuli::CurrentStimulus::~CurrentStimulus ( )

virtual

Destructor.

Author: dcofer

Date: 3/16/2011

Definition at line 85 of file CurrentStimulus.cpp.

References m_lpCurrentOnEval, m_lpExternalCurrent, AnimatSim::AnimatBase::m_lpNode, and StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

void AnimatSim::ExternalStimuli::CurrentStimulus::Activate ( )

virtual

Activates this item.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 434 of file CurrentStimulus.cpp.

References AnimatSim::ActivatedItem::Activate(), GetCurrentOn(), m_fltActiveCurrent, m_lBurstStart, m_lCycleStart, m_lpExternalCurrent, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::TimeSlice().

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::AlwaysActive ( bool bVal )

virtual

Sets whether this item is always active.

Author: dcofer

Date: 3/1/2011

Parameters

bVal	true if always active.

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 133 of file CurrentStimulus.cpp.

References AnimatSim::ActivatedItem::AlwaysActive(), AnimatSim::ActivatedItem::m_bAlwaysActive, m_fltBurstOnDuration, m_fltCycleOnDuration, and m_iType.

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::BurstOffDuration ( )

virtual

Gets the off burst current duration in time.

Author: dcofer

Date: 3/16/2011

Returns: Off burst duration value.

Definition at line 294 of file CurrentStimulus.cpp.

References m_fltBurstOffDuration.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::BurstOffDuration ( float fltVal )

virtual

Sets the off burst duration value in time.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 304 of file CurrentStimulus.cpp.

References m_fltBurstOffDuration, m_lBurstOffDuration, AnimatSim::AnimatBase::m_lpSim, StdUtils::Std_IsAboveMin(), and AnimatSim::Simulator::TimeStep().

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::BurstOnDuration ( )

virtual

Gets the on burst current duration in time.

Author: dcofer

Date: 3/16/2011

Returns: On burst duration value.

Definition at line 269 of file CurrentStimulus.cpp.

References m_fltBurstOnDuration.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::BurstOnDuration ( float fltVal )

virtual

Sets the on burst duration value in time.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 279 of file CurrentStimulus.cpp.

References m_fltBurstOnDuration, m_lBurstOnDuration, AnimatSim::AnimatBase::m_lpSim, StdUtils::Std_IsAboveMin(), and AnimatSim::Simulator::TimeStep().

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::CurrentBurstOff ( )

virtual

Gets the off burst current value.

Author: dcofer

Date: 3/16/2011

Returns: Off burst current value.

Definition at line 199 of file CurrentStimulus.cpp.

References m_fltCurrentBurstOff.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CurrentBurstOff ( float fltVal )

virtual

Sets the of burst current value.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 209 of file CurrentStimulus.cpp.

References m_fltCurrentBurstOff.

std::string AnimatSim::ExternalStimuli::CurrentStimulus::CurrentEquation ( )

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 345 of file CurrentStimulus.cpp.

References m_strCurrentEquation.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CurrentEquation ( 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 357 of file CurrentStimulus.cpp.

References StdUtils::CStdPostFixEval::AddVariable(), StdUtils::CStdPostFixEval::Equation(), m_fltActiveCurrent, m_fltCurrentOn, m_fltInitialActiveCurrent, m_lpCurrentOnEval, m_strCurrentEquation, StdUtils::CStdPostFixEval::SetVariable(), StdUtils::CStdPostFixEval::Solve(), and StdUtils::Std_IsBlank().

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::CurrentOff ( )

virtual

Gets the ffn cycle current value.

Author: dcofer

Date: 3/16/2011

Returns: Offn cycle current value.

Definition at line 179 of file CurrentStimulus.cpp.

References m_fltCurrentOff.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CurrentOff ( float fltVal )

virtual

Sets the off cycle current value.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 189 of file CurrentStimulus.cpp.

References m_fltCurrentOff.

float AnimatSim::ExternalStimuli::CurrentStimulus::CurrentOn ( )

virtual

Gets the on cycle current value.

Author: dcofer

Date: 3/16/2011

Returns: On cycle current value.

Definition at line 158 of file CurrentStimulus.cpp.

References m_fltCurrentOn.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CurrentOn ( float fltVal )

virtual

Sets the on cycle current value.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 168 of file CurrentStimulus.cpp.

References m_fltCurrentOn.

float AnimatSim::ExternalStimuli::CurrentStimulus::CycleOffDuration ( )

virtual

Gets the off cycle current duration in time.

Author: dcofer

Date: 3/16/2011

Returns: Off cycle duration value.

Definition at line 244 of file CurrentStimulus.cpp.

References m_fltCycleOffDuration.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CycleOffDuration ( float fltVal )

virtual

Sets the off cycle duration value in time.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 254 of file CurrentStimulus.cpp.

References m_fltCycleOffDuration, m_lCycleOffDuration, AnimatSim::AnimatBase::m_lpSim, StdUtils::Std_IsAboveMin(), and AnimatSim::Simulator::TimeStep().

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::CycleOnDuration ( )

virtual

Gets the on cycle current duration in time.

Author: dcofer

Date: 3/16/2011

Returns: On cycle duration value.

Definition at line 219 of file CurrentStimulus.cpp.

References m_fltCycleOnDuration.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::CycleOnDuration ( float fltVal )

virtual

Sets the on cycle duration value in time.

Author: dcofer

Date: 3/16/2011

Parameters

fltVal The new value.

Definition at line 229 of file CurrentStimulus.cpp.

References m_fltCycleOnDuration, m_lCycleOnDuration, AnimatSim::AnimatBase::m_lpSim, StdUtils::Std_IsAboveMin(), and AnimatSim::Simulator::TimeStep().

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::Deactivate ( )

virtual

Deactivates this item.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 504 of file CurrentStimulus.cpp.

References AnimatSim::ActivatedItem::Deactivate(), m_fltActiveCurrent, and m_lpExternalCurrent.

Here is the call graph for this function:

float AnimatSim::ExternalStimuli::CurrentStimulus::GetCurrentOn ( )

protectedvirtual

Calculates the on cycle current at this time step.

Author: dcofer

Date: 3/17/2011

Returns: The current on.

Definition at line 412 of file CurrentStimulus.cpp.

References m_fltCurrentOn, AnimatSim::ActivatedItem::m_fltStartTime, m_lpCurrentOnEval, AnimatSim::AnimatBase::m_lpSim, StdUtils::CStdPostFixEval::SetVariable(), StdUtils::CStdPostFixEval::Solve(), and AnimatSim::Simulator::Time().

Referenced by Activate(), and StepSimulation().

Here is the call graph for this function:

Here is the caller graph for this function:

float * AnimatSim::ExternalStimuli::CurrentStimulus::GetDataPointer ( const std::string & strDataType )

virtual

Returns a float pointer to a data item of interest in this object.

This is a generic method used to get a pointer to data variable of interest. It is used by a variety of systems in the simulation. The most prominent are the data charting and stimulus classes. Within this method we associate a variable with a string name. By passing in the name of the data type we are interested in we can recieve back a float pointer to that data type. We can use that to read or set the data item in other classes. For example, the data charting system gets the pointer and then each time it needs to log a data point it reads the value into an array.

Author: dcofer

Date: 2/22/2011

Parameters

strDataType name of the data item for which we are looking.

Returns: float pointer of the data item. If not found then it throws an exception.

Exceptions

If	DataType is not found.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 521 of file CurrentStimulus.cpp.

References m_fltActiveCurrent, AnimatSim::AnimatBase::m_strName, and StdUtils::Std_CheckString().

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::Initialize ( )

virtual

Initializes this object.

After an object is loaded in it must be initialized before it can be used. This allows the object to retrieve any pointers or setup memory that it will need during execution. Each object is responsible for initializing any of its child objects, so you simply need to call this method on the containing class to init all child objects. It also calls VerifySystemPointers to make sure that the system pointers have been setup correctly.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 388 of file CurrentStimulus.cpp.

References AnimatSim::Simulator::FindByID(), AnimatSim::AnimatBase::GetDataPointer(), AnimatSim::ActivatedItem::Initialize(), m_lpExternalCurrent, AnimatSim::AnimatBase::m_lpNode, AnimatSim::AnimatBase::m_lpSim, AnimatSim::AnimatBase::m_strID, and m_strTargetNodeID.

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::QueryProperties ( CStdPtrArray< TypeProperty > & aryProperties )

virtual

Queries this object for a list of properties that can be changed using SetData.

The method provides a list of the properties that can be set using the SetData method. It gives the property name and the type of data that should be passed to it. Valid date types are Boolean, Float, Integer, and Xml.

Author: dcofer

Date: 2/22/2011

Parameters

aryNames	Array list of the property names.
strTypes	Array list of the type that is associated with the cooresponding name in the list.

Returns: Nothing.

Reimplemented from AnimatSim::ExternalStimuli::ExternalStimulus.

Definition at line 596 of file CurrentStimulus.cpp.

References AnimatSim::ExternalStimuli::ExternalStimulus::QueryProperties().

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::ResetSimulation ( )

virtual

Resets the simulation back to time 0.

This method calls the ResetSimulation method on all subitems in order to reset the simulation back to the beginning.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 510 of file CurrentStimulus.cpp.

References m_bBurstOn, m_bCycleOn, m_fltActiveCurrent, m_fltInitialActiveCurrent, m_lBurstStart, m_lCycleStart, and AnimatSim::ActivatedItem::ResetSimulation().

Here is the call graph for this function:

bool AnimatSim::ExternalStimuli::CurrentStimulus::SetData	(	const std::string &	strDataType,
		const std::string &	strValue,
		bool	bThrowError = `true`
	)

virtual

Set a variable based on a string data type name.

This is a generic method that can be used to set any variable in an AnimatBase object by specifying the name of the variable and a string representation of that data. The GUI uses this method to set data into variables in the simulation when the user changes them in the UI. The value string can be as simple as a float or int, or as complex as an xml packet. It is the developers responsibilty to know what type of data is needed and to process it accordingly.

Author: dcofer

Date: 2/22/2011

Parameters

strDataType	string name of the data type to set.
strValue	The string value of the data. It is up to the developer to determine what this should be. For example, in most cases it is simply a float and you just have to convert it to a float and make the appropriate mutator method call. However, it can be any type of string, including an entire xml packet. It is the developers responsibility to know how to set and process the data as required.
bThrowError	true to throw error if there is a problem. If false then it will not return an error, just return false.

Returns: true if it succeeds, false if it fails.

Reimplemented from AnimatSim::ExternalStimuli::ExternalStimulus.

Definition at line 534 of file CurrentStimulus.cpp.

References BurstOffDuration(), BurstOnDuration(), CurrentBurstOff(), CurrentEquation(), CurrentOff(), CurrentOn(), CycleOffDuration(), CycleOnDuration(), AnimatSim::ExternalStimuli::ExternalStimulus::SetData(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

void AnimatSim::ExternalStimuli::CurrentStimulus::StepSimulation ( )

virtual

Step the simulation for this object.

This is called on an object each time it is stepped in the simulation. this is where its simulation code is processed. However, StepSimulation is not necessarily called every single time that the simulation as a whole is stepped. A good example of this is that neural modules can have different integration time steps. So a firing rate module may have a DT of 0.5 ms, while an integrate and fire model may have one of 0.1 ms. So the firing rate module would only get its StepSimulation method called every 5th time that the other module was called. This is all handed in the StepSimulation method of the Simulator and NervousSystem.