Gated firing rate synapse. More...

#include <GatedSynapse.h>

Inheritance diagram for FiringRateSim::Synapses::GatedSynapse:

Collaboration diagram for FiringRateSim::Synapses::GatedSynapse:

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

virtual	~GatedSynapse ()
	Destructor. More...

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

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

virtual unsigned char	InitialGateValue ()
	Gets the initial gate value. More...

virtual void	InitialGateValue (unsigned char iVal)
	Sets the initial gate value. More...

virtual void	Load (CStdXml &oXml)

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

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

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

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

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

virtual void	Process (float &fltCurrent)
	Processes this synapse. 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	ResetSimulation ()
	Resets the simulation back to time 0. 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
unsigned char	m_iInitialGateValue
	Tells whether the gate is initially open or closed.

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

Gated firing rate synapse.

A gated synapse modulates another, regular synapse that is also connected to the same post-synaptic neuron. It gates it, or turns it on or off. Regular synapses keep a list of all of synapses that modulate it. While it is calculating its synaptic current it calls CalculateModulation for all CompoundSynapses to determine how to modulate itself. The user can have the gate initially on or off, and activity in the pre-synaptic neuron controls closing/opening of the gate.

Author: dcofer

Date: 3/30/2011

Definition at line 25 of file GatedSynapse.h.

Constructor & Destructor Documentation

FiringRateSim::Synapses::GatedSynapse::GatedSynapse ( )

Default constructor.

Author: dcofer

Date: 3/30/2011

Definition at line 24 of file GatedSynapse.cpp.

References m_iInitialGateValue, and AnimatSim::AnimatBase::m_strType.

FiringRateSim::Synapses::GatedSynapse::~GatedSynapse ( )

virtual

Destructor.

Author: dcofer

Date: 3/30/2011

Definition at line 36 of file GatedSynapse.cpp.

Member Function Documentation

float FiringRateSim::Synapses::GatedSynapse::CalculateModulation ( FiringRateModule * m_lpFRModule )

virtual

Calculates the synaptic modulation.

Author: dcofer

Date: 3/29/2011

Parameters

[in,out] m_lpFRModule Pointer to a fast module.

Returns: The calculated modulation.

Reimplemented from FiringRateSim::Synapses::Synapse.

Definition at line 61 of file GatedSynapse.cpp.

References FiringRateSim::Neurons::Neuron::FiringFreq(), AnimatSim::AnimatBase::m_bEnabled, FiringRateSim::Synapses::Synapse::m_fltModulation, FiringRateSim::Synapses::Synapse::m_fltWeight, m_iInitialGateValue, and FiringRateSim::Synapses::Synapse::m_lpFromNeuron.

Here is the call graph for this function:

float * FiringRateSim::Synapses::GatedSynapse::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 FiringRateSim::Synapses::Synapse.

Definition at line 75 of file GatedSynapse.cpp.

References FiringRateSim::Synapses::Synapse::GetDataPointer(), FiringRateSim::Synapses::Synapse::m_fltModulation, and StdUtils::Std_CheckString().

Here is the call graph for this function:

unsigned char FiringRateSim::Synapses::GatedSynapse::InitialGateValue ( )

virtual

Gets the initial gate value.

Author: dcofer

Date: 3/30/2011

Returns: initial gate value.

Definition at line 49 of file GatedSynapse.cpp.

References m_iInitialGateValue.

Referenced by SetData().

Here is the caller graph for this function:

void FiringRateSim::Synapses::GatedSynapse::InitialGateValue ( unsigned char iVal )

virtual

Sets the initial gate value.

Author: dcofer

Date: 3/30/2011

Parameters

iVal	The new value.

Definition at line 59 of file GatedSynapse.cpp.

References m_iInitialGateValue.

bool FiringRateSim::Synapses::GatedSynapse::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 85 of file GatedSynapse.cpp.

References InitialGateValue(), FiringRateSim::Synapses::Synapse::SetData(), StdUtils::Std_CheckString(), and StdUtils::Std_ToBool().

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