Firing rate synapse model. More...

#include <CsConnectionGenerator.h>

Inheritance diagram for AnimatCarlSim::CsConnectionGenerator:

Collaboration diagram for AnimatCarlSim::CsConnectionGenerator:

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

	CsConnectionGenerator (int iFromGroupID, int iToGroupID, bool bPlastic, Simulator lpSim, Structure lpStructure, NeuralModule *lpModule)
	Default constructor. More...

virtual	~CsConnectionGenerator ()
	Destructor. More...

virtual void	connect (CpuSNN *s, int srcGrpId, int i, int destGrpId, int j, float &weight, float &maxWt, float &delay, bool &connected)
	specifies which synaptic connections (per group, per neuron, per synapse) should be made More...

virtual void	FromGroupID (int iVal)

virtual int	FromGroupID ()

virtual void	Plastic (bool bVal)

virtual bool	Plastic ()

virtual void	SetCARLSimulation ()

virtual void	SetSystemPointers (Simulator lpSim, Structure lpStructure, NeuralModule lpModule, Node lpNode, bool bVerify)

std::multimap< std::pair< int, int >, CsSynapseIndividual * > *	SynapseMap ()

virtual void	ToGroupID (int iVal)

virtual int	ToGroupID ()

virtual void	VerifySystemPointers ()
	Verify that system pointers have been set correctly. 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 void	Enabled (bool bVal)
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...

virtual bool	Enabled ()
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...

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	Initialize ()
	Initializes this 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	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. More...

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 std::string &strValue, bool bThrowError=true)
	Set a variable based on a string data type name. 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	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
std::multimap< std::pair< int, int >, CsSynapseIndividual * >	m_arySynapseMap
	A map relating the pre/post synaptic index to a given synapse.

bool	m_bPlastic
	Tells whether the connections generated by this class are plastic or fixed.

int	m_iFromGroupID
	The ID of the pre-synaptic neuron population.

int	m_iToGroupID
	The ID of the post-synaptic neuron population.

CsNeuralModule *	m_lpCsModule
	Pointer to parent CsNeuralModule.

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

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 23 of file CsConnectionGenerator.h.

Constructor & Destructor Documentation

AnimatCarlSim::CsConnectionGenerator::CsConnectionGenerator ( )

Default constructor.

Author: dcofer

Date: 3/29/2011

Definition at line 23 of file CsConnectionGenerator.cpp.

References m_iFromGroupID, m_iToGroupID, and m_lpCsModule.

AnimatCarlSim::CsConnectionGenerator::CsConnectionGenerator	(	int	iFromGroupID,
		int	iToGroupID,
		bool	bPlastic,
		Simulator *	lpSim,
		Structure *	lpStructure,
		NeuralModule *	lpModule
	)

Default constructor.

Author: dcofer

Date: 3/29/2011

Definition at line 36 of file CsConnectionGenerator.cpp.

References m_bPlastic, m_iFromGroupID, and m_iToGroupID.

AnimatCarlSim::CsConnectionGenerator::~CsConnectionGenerator ( )

virtual

Destructor.

Author: dcofer

Date: 3/29/2011

Definition at line 51 of file CsConnectionGenerator.cpp.

References StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

void AnimatCarlSim::CsConnectionGenerator::connect	(	CpuSNN *	s,
		int	srcGrpId,
		int	i,
		int	destGrpId,
		int	j,
		float &	weight,
		float &	maxWt,
		float &	delay,
		bool &	connected
	)

virtual

specifies which synaptic connections (per group, per neuron, per synapse) should be made

Attention: The virtual method should never be called directly

Reimplemented from ConnectionGenerator.

Definition at line 100 of file CsConnectionGenerator.cpp.

References m_arySynapseMap.

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

Definition at line 83 of file CsConnectionGenerator.cpp.

References AnimatSim::AnimatBase::ID(), m_lpCsModule, 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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation