Firing rate synapse model. More...

#include <CsSynapseGroup.h>

Inheritance diagram for AnimatCarlSim::CsSynapseGroup:

Collaboration diagram for AnimatCarlSim::CsSynapseGroup:

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

virtual	~CsSynapseGroup ()
	Destructor. More...

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

virtual std::string	GeneratorKey ()

CsNeuralModule *	GetCsModule ()

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

virtual void	InitWt (float fltVal)

virtual float	InitWt ()

virtual void	Load (CStdXml &oXml)

virtual void	MaxDelay (unsigned char iVal)

virtual unsigned char	MaxDelay ()

virtual void	MaxWt (float fltVal)

virtual float	MaxWt ()

virtual void	MinDelay (unsigned char iVal)

virtual unsigned char	MinDelay ()

virtual void	Pconnect (float fltVal)

virtual float	Pconnect ()

virtual void	Plastic (bool bVal)

virtual bool	Plastic ()

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

virtual void	SetCARLSimulation ()

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	SetSystemPointers (Simulator lpSim, Structure lpStructure, NeuralModule lpModule, Node lpNode, bool bVerify)

virtual int	SynapsesCreated ()

virtual void	VerifySystemPointers ()
	Verify that system pointers have been set correctly. 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 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 float *	GetDataPointer (const std::string &strDataType)
	Returns a float pointer to a data item of interest in this object. More...

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 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	ResetSimulation ()
	Resets the simulation back to time 0. 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 void	TimeStepModified ()
	Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. 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
bool	m_bPlastic
	connection type, either SYN_FIXED or SYN_PLASTIC

float	m_fltInitWt
	initial weight strength (arbitrary units); should be negative for inhibitory connections

float	m_fltMaxWt
	upper bound on weight strength (arbitrary units); should be negative for inhibitory connections

float	m_fltPconnect
	connection probability

unsigned char	m_iMaxDelay
	the maximum delay allowed (ms)

unsigned char	m_iMinDelay
	the minimum delay allowed (ms)

int	m_iSynapsesCreated
	The total number of synapses created.

CsNeuralModule *	m_lpCsModule
	Pointer to parent CsNeuralModule.

CsNeuronGroup *	m_lpFromNeuron
	The pointer to pre-synaptic neuron.

CsNeuronGroup *	m_lpToNeuron
	The pointer to post-synaptic neuron.

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

std::string	m_strToID
	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 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.

This synapse type has a weight that is a current value. It injects a portion of that weight into the post-synaptic neuron based on the pre-synaptic neurons firing rate. I = W*F. (Where W is the weight, F is the firing rate, and I is the current.)

Author: dcofer

Date: 3/29/2011

Definition at line 22 of file CsSynapseGroup.h.

Constructor & Destructor Documentation

AnimatCarlSim::CsSynapseGroup::CsSynapseGroup ( )

Default constructor.

Author: dcofer

Date: 3/29/2011

Definition at line 22 of file CsSynapseGroup.cpp.

References AnimatSim::AnimatBase::m_bEnabled, m_bPlastic, m_fltInitWt, m_fltMaxWt, m_fltPconnect, m_iMaxDelay, m_iMinDelay, m_iSynapsesCreated, m_lpCsModule, m_lpFromNeuron, and m_lpToNeuron.

AnimatCarlSim::CsSynapseGroup::~CsSynapseGroup ( )

virtual

Destructor.

Author: dcofer

Date: 3/29/2011

Definition at line 45 of file CsSynapseGroup.cpp.

References StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

CsNeuronGroup* AnimatCarlSim::CsSynapseGroup::FromNeuron ( )

inline

Gets the pre-synaptic neuron.

Author: dcofer

Date: 3/29/2011

Returns: Pointer to the neuron.

Definition at line 75 of file CsSynapseGroup.h.

void AnimatCarlSim::CsSynapseGroup::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::AnimatBase.

Definition at line 121 of file CsSynapseGroup.cpp.

References AnimatSim::Simulator::FindByID(), m_lpFromNeuron, AnimatSim::AnimatBase::m_lpSim, m_lpToNeuron, m_strFromID, and m_strToID.

Referenced by AnimatCarlSim::CsNeuralModule::AddSynapse().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatCarlSim::CsSynapseGroup::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::Link.

Reimplemented in AnimatCarlSim::CsSynapseIndividual, and AnimatCarlSim::CsSynapseFull.

Definition at line 162 of file CsSynapseGroup.cpp.

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

Referenced by AnimatCarlSim::CsSynapseFull::SetData(), and AnimatCarlSim::CsSynapseIndividual::SetData().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatCarlSim::CsSynapseGroup::VerifySystemPointers ( )

virtual

Verify that system pointers have been set correctly.

The system pointers should be set just after an object is created. However, if for some reason it was not then this could cause read/write memory access errors later on because we would be using NULL pointers. This method is called during SetSystemPointers, Load, and Initialize to verify that the pointers for that type of object have been set correctly. We are calling three different places to ensure that it is checked before use. For example, if you are doing a Load call then you want to check it before attempting the load, but there may be an object that does not Load, but only does Initialize. So we need to check it there as well.

Author: dcofer

Date: 3/4/2011

Reimplemented from AnimatSim::Link.

Definition at line 143 of file CsSynapseGroup.cpp.

References AnimatSim::AnimatBase::ID(), m_lpCsModule, AnimatSim::AnimatBase::m_lpModule, AnimatSim::Link::m_lpOrganism, AnimatSim::AnimatBase::m_lpStructure, and AnimatSim::AnimatBase::m_strID.

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