AnimatLab  2
Test
AnimatCarlSim::CsSynapseIndividual Class Reference

Firing rate synapse model. More...

#include <CsSynapseIndividual.h>

+ Inheritance diagram for AnimatCarlSim::CsSynapseIndividual:
+ Collaboration diagram for AnimatCarlSim::CsSynapseIndividual:

Public Member Functions

 CsSynapseIndividual ()
 Default constructor. More...
 
virtual ~CsSynapseIndividual ()
 Destructor. More...
 
virtual void FromIdx (int iVal)
 
virtual int FromIdx ()
 
virtual void Load (CStdXml &oXml)
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 
virtual void SetCARLSimulation ()
 
virtual bool SetCARLSimulation (int iFromIdx, int iToIdx, float &weight, float &maxWt, float &delay, bool &connected)
 
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 std::pair< int, int > SynapseIndexKey ()
 
virtual void ToIdx (int iVal)
 
virtual int ToIdx ()
 
- Public Member Functions inherited from AnimatCarlSim::CsSynapseGroup
 CsSynapseGroup ()
 Default constructor. More...
 
virtual ~CsSynapseGroup ()
 Destructor. More...
 
CsNeuronGroupFromNeuron ()
 Gets the pre-synaptic neuron. More...
 
virtual std::string GeneratorKey ()
 
CsNeuralModuleGetCsModule ()
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual void InitWt (float fltVal)
 
virtual float InitWt ()
 
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 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::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 NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 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

int m_iFromIdx
 The Ith neuron of the pre-synaptic group to connect.
 
int m_iToIdx
 The Jth neuron of the post-synaptic group to connect.
 
std::pair< int, int > m_vSynapseKey
 The synapse index key used in the synapse map.
 
- Protected Attributes inherited from AnimatCarlSim::CsSynapseGroup
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.
 
CsNeuralModulem_lpCsModule
 Pointer to parent CsNeuralModule.
 
CsNeuronGroupm_lpFromNeuron
 The pointer to pre-synaptic neuron.
 
CsNeuronGroupm_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::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::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_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

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

Constructor & Destructor Documentation

AnimatCarlSim::CsSynapseIndividual::CsSynapseIndividual ( )

Default constructor.

Author
dcofer
Date
3/29/2011

Definition at line 23 of file CsSynapseIndividual.cpp.

AnimatCarlSim::CsSynapseIndividual::~CsSynapseIndividual ( )
virtual

Destructor.

Author
dcofer
Date
3/29/2011

Definition at line 33 of file CsSynapseIndividual.cpp.

References StdUtils::Std_TraceMsg().

+ Here is the call graph for this function:

Member Function Documentation

bool AnimatCarlSim::CsSynapseIndividual::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
strDataTypestring name of the data type to set.
strValueThe 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.
bThrowErrortrue 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 AnimatCarlSim::CsSynapseGroup.

Definition at line 103 of file CsSynapseIndividual.cpp.

References AnimatCarlSim::CsSynapseGroup::SetData(), and StdUtils::Std_CheckString().

+ Here is the call graph for this function:


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