AnimatLab  2
Test
IntegrateFireSim::Synapses::SynapseType Class Reference

Synapse type base class. More...

#include <SynapseType.h>

+ Inheritance diagram for IntegrateFireSim::Synapses::SynapseType:
+ Collaboration diagram for IntegrateFireSim::Synapses::SynapseType:

Public Member Functions

 SynapseType ()
 Default constructor. More...
 
virtual ~SynapseType ()
 Destructor. More...
 
void NeuralModule (IntegrateFireNeuralModule *lpModule)
 Sets the NeuralModule pointer. More...
 
virtual void SetSystemPointers (Simulator *lpSim, Structure *lpStructure, AnimatSim::Behavior::NeuralModule *lpModule, Node *lpNode, bool bVerify)
 
int SynapseTypeID ()
 Gets the synapse type identifier. More...
 
void SynapseTypeID (int iID)
 Sets the synapse type identifier. More...
 
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 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 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

int m_iSynapseTypeID
 Integre ID for the synapse type.
 
IntegrateFireNeuralModulem_lpIGFModule
 Pointer to the parent IntegrateFireNeuralModule.
 
- 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..
 

Detailed Description

Synapse type base class.

All of the other synapse types are derived from this common base. This includes the SpikingChemicalSynapse, NonSpikingChemicalSynapse, and ElectricalSynapse.

Author
dcofer
Date
3/31/2011

Definition at line 22 of file SynapseType.h.

Constructor & Destructor Documentation

IntegrateFireSim::Synapses::SynapseType::SynapseType ( )

Default constructor.

Author
dcofer
Date
3/31/2011

Definition at line 31 of file SynapseType.cpp.

References m_iSynapseTypeID, and m_lpIGFModule.

IntegrateFireSim::Synapses::SynapseType::~SynapseType ( )
virtual

Destructor.

Author
dcofer
Date
3/31/2011

Definition at line 43 of file SynapseType.cpp.

Member Function Documentation

void IntegrateFireSim::Synapses::SynapseType::NeuralModule ( IntegrateFireNeuralModule lpModule)

Sets the NeuralModule pointer.

Author
dcofer
Date
3/31/2011
Parameters
[in,out]lpModulePointer to the NeuralModule.

Definition at line 58 of file SynapseType.cpp.

References AnimatSim::AnimatBase::m_lpModule.

int IntegrateFireSim::Synapses::SynapseType::SynapseTypeID ( )

Gets the synapse type identifier.

Author
dcofer
Date
3/31/2011
Returns
synapse type identifier.

Definition at line 68 of file SynapseType.cpp.

References m_iSynapseTypeID.

Referenced by IntegrateFireSim::IntegrateFireNeuralModule::LoadElecSyn(), IntegrateFireSim::IntegrateFireNeuralModule::LoadNonSpikingChemSyn(), IntegrateFireSim::IntegrateFireNeuralModule::LoadSpikingChemSyn(), and IntegrateFireSim::Synapses::Connexion::ResetIDs().

+ Here is the caller graph for this function:

void IntegrateFireSim::Synapses::SynapseType::SynapseTypeID ( int  iID)

Sets the synapse type identifier.

Author
dcofer
Date
3/31/2011
Parameters
iIDThe identifier.

Definition at line 78 of file SynapseType.cpp.

References m_iSynapseTypeID.

void IntegrateFireSim::Synapses::SynapseType::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 91 of file SynapseType.cpp.

References m_lpIGFModule, and AnimatSim::AnimatBase::m_strID.


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