Firing rate synapse model for modulating neuron properties. More...

#include <ModulateNeuronPropSynapse.h>

Inheritance diagram for FiringRateSim::Synapses::ModulateNeuronPropSynapse:

Collaboration diagram for FiringRateSim::Synapses::ModulateNeuronPropSynapse:

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

virtual	~ModulateNeuronPropSynapse ()
	Destructor. More...

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

virtual void	Load (CStdXml &oXml)

AnimatSim::Gains::Gain *	ModulationGain ()

void	ModulationGain (AnimatSim::Gains::Gain *lpGain)
	Sets the current distribution. More...

void	ModulationGain (std::string strXml)
	Sets the current distribution using an xml packet. More...

virtual void	Process (float &fltCurrent)
	Processes this synapse. More...

virtual void	PropertyName (std::string strPropName)
	Sets the name of the property that this adapter will be setting. More...

virtual std::string	PropertyName ()
	Gets the name of the property that this adapter will be setting. More...

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

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

Public Member Functions inherited from FiringRateSim::Synapses::Synapse
	Synapse ()
	Default constructor. More...

virtual	~Synapse ()
	Destructor. 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	AddSynapse (std::string strXml, bool bDoNotInit)
	Adds a compound synapse to this one. More...

virtual float	CalculateCurrent ()
	Calculates the synaptic current for this synapse. More...

virtual float	CalculateModulation (FiringRateModule *lpModule)
	Calculates the synaptic modulation. More...

virtual void	DelayInterval (float fltVal)
	Sets the delay buffer interval. More...

virtual float	DelayInterval ()
	Gets the delay buffer size in time. More...

virtual int	FindSynapseListPos (std::string strID, bool bThrowError=true)
	Searches for the first synapse list position. More...

Neuron *	FromNeuron ()
	Gets the pre-synaptic neuron. More...

virtual Synapse *	GetCompoundSynapse (short iCompoundIndex)
	Gets a pointer to a compound synapse. More...

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

virtual bool	HasDelay ()
	Gets whether this synapse has a delay associated with it. More...

virtual void	HasDelay (bool bVal)
	Sets whether this synapse has a delay associated with it. More...

float	Modulation ()
	Gets the synaptic modulation. More...

float *	ModulationPointer ()
	Gets a pointer to the synaptic modulation. More...

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

virtual void	RemoveSynapse (std::string strID, bool bThrowError=true)
	Removes the copmound synapse specified by ID. More...

virtual void	SetDelayBufferSize ()
	Recalculates the size of the delay buffer required. More...

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

virtual void	TimeStepModified ()
	If the time step is modified then we need to recalculate the length of the delay buffer. More...

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

float	Weight ()
	Gets the synaptic weight. More...

void	Weight (float fltVal)
	Sets the synaptic weight. More...

float *	WeightPointer ()
	Gets a pointer to the synaptic weight. More...

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

virtual	~Link ()
	Destructor. More...

virtual bool	Enabled ()
	Gets whether the link is enabled. More...

virtual void	Enabled (bool bValue)
	Sets whether the link is Enabled. More...

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

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

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

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. 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 void	ReInitialize ()
	Re-initialize this object. 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	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	StepSimulation ()
	Step the simulation for this object. More...

virtual std::string	Type ()
	returns the string type name of this object. More...

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

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

Protected Attributes
AnimatSim::Gains::Gain *	m_lpGain
	Pointer to the graph used to calculate the hi current.

float *	m_lpPropertyData
	Pointer to the property we are modulating.

std::string	m_strPropertyName
	The name of the property we are modulating.

Protected Attributes inherited from FiringRateSim::Synapses::Synapse
CStdCircularArray< float >	m_aryDelayBuffer

CStdPtrArray< Synapse >	m_arySynapses
	Array of moduled/gated child synapses.

bool	m_bHasDelay

float	m_fltDelayInterval

float	m_fltModulation
	The modulation value to use for this synapse.

float	m_fltWeight
	The weight of the synapse. This is a current value in nanoamps.

FiringRateModule *	m_lpFRModule
	Pointer to parent FiringRateModule.

Neuron *	m_lpFromNeuron
	The pointer to pre-synaptic neuron.

Neuron *	m_lpToNeuron
	The pointer to post-synaptic neuron.

std::string	m_strFromID
	GUID ID of the pre-synaptic neruon.

Protected Attributes inherited from AnimatSim::Link
float	m_fltEnabled
	This is for reporting purposes.

Organism *	m_lpOrganism
	The pointer to this link's organism.

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

Additional Inherited Members
Static Public Member Functions inherited from AnimatSim::Link
static Link *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions inherited from FiringRateSim::Synapses::Synapse
Synapse *	LoadSynapse (CStdXml &oXml)
	Loads a synapse. More...

Protected Member Functions inherited from AnimatSim::Link
virtual void	UpdateData ()
	Called during the StepSimulation method to allow the link to update any internal data for reporting purposes. More...

Detailed Description

Firing rate synapse model for modulating neuron properties.

This synapse can modulate any of the neural properties based on the firing rate of the pre-synaptic neuron

Author: dcofer

Date: 6/17/2014

Definition at line 21 of file ModulateNeuronPropSynapse.h.

Constructor & Destructor Documentation

FiringRateSim::Synapses::ModulateNeuronPropSynapse::ModulateNeuronPropSynapse ( )

Default constructor.

Author: dcofer

Date: 3/29/2011

Definition at line 25 of file ModulateNeuronPropSynapse.cpp.

References m_lpGain, and m_lpPropertyData.

FiringRateSim::Synapses::ModulateNeuronPropSynapse::~ModulateNeuronPropSynapse ( )

virtual

Destructor.

Author: dcofer

Date: 3/29/2011

Definition at line 37 of file ModulateNeuronPropSynapse.cpp.

References m_lpGain, and StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::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 FiringRateSim::Synapses::Synapse.

Definition at line 113 of file ModulateNeuronPropSynapse.cpp.

References FiringRateSim::Neurons::Neuron::GetDataPointer(), FiringRateSim::Synapses::Synapse::Initialize(), m_lpPropertyData, FiringRateSim::Synapses::Synapse::m_lpToNeuron, m_strPropertyName, and StdUtils::Std_IsBlank().

Here is the call graph for this function:

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::ModulationGain ( AnimatSim::Gains::Gain * lpGain )

Sets the current distribution.

Author: dcofer

Date: 3/29/2011

Parameters

[in,out] lpGain Pointer to a gain.

Definition at line 56 of file ModulateNeuronPropSynapse.cpp.

References m_lpGain.

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::ModulationGain ( std::string strXml )

Sets the current distribution using an xml packet.

Author: dcofer

Date: 3/29/2011

Parameters

strXml The xml packet defining the gain.

Definition at line 74 of file ModulateNeuronPropSynapse.cpp.

References AnimatSim::Gains::LoadGain(), and AnimatSim::AnimatBase::m_lpSim.

Here is the call graph for this function:

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::Process ( float & fltCurrent )

virtual

Processes this synapse.

Author: dcofer

Date: 6/17/2014

Returns: Synaptic current.

Reimplemented from FiringRateSim::Synapses::Synapse.

Definition at line 157 of file ModulateNeuronPropSynapse.cpp.

References AnimatSim::Gains::Gain::CalculateGain(), FiringRateSim::Neurons::Neuron::FiringFreq(), FiringRateSim::Synapses::Synapse::FromNeuron(), FiringRateSim::Synapses::Synapse::m_lpFRModule, m_lpGain, and m_lpPropertyData.

Here is the call graph for this function:

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::PropertyName ( std::string strPropName )

virtual

Sets the name of the property that this adapter will be setting.

Author: dcofer

Date: 2/6/2013

Returns: nothing.

Definition at line 91 of file ModulateNeuronPropSynapse.cpp.

References FiringRateSim::Neurons::Neuron::GetDataPointer(), m_lpPropertyData, FiringRateSim::Synapses::Synapse::m_lpToNeuron, m_strPropertyName, and StdUtils::Std_IsBlank().

Here is the call graph for this function:

std::string FiringRateSim::Synapses::ModulateNeuronPropSynapse::PropertyName ( )

virtual

Gets the name of the property that this adapter will be setting.

Author: dcofer

Date: 2/6/2013

Returns: Name of property that will be set.

Definition at line 110 of file ModulateNeuronPropSynapse.cpp.

References m_strPropertyName.

Referenced by SetData().

Here is the caller graph for this function:

void FiringRateSim::Synapses::ModulateNeuronPropSynapse::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 FiringRateSim::Synapses::Synapse.

Definition at line 177 of file ModulateNeuronPropSynapse.cpp.

bool FiringRateSim::Synapses::ModulateNeuronPropSynapse::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 FiringRateSim::Synapses::Synapse.

Definition at line 123 of file ModulateNeuronPropSynapse.cpp.

References PropertyName(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation