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

Non-spiking chemical synapse type. More...

#include <NonSpikingChemicalSynapse.h>

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

Public Member Functions

 NonSpikingChemicalSynapse ()
 Default constructor. More...
 
virtual ~NonSpikingChemicalSynapse ()
 Destructor. More...
 
void EquilibriumPotential (double dVal)
 Sets the equilibrium potential. More...
 
double EquilibriumPotential ()
 Gets the equilibrium potential. More...
 
virtual void Load (CStdXml &oXml)
 
void MaxSynapticConductance (double dVal)
 Sets the maximum synaptic conductance. More...
 
double MaxSynapticConductance ()
 Gets the maximum synaptic conductance. More...
 
void PreSynapticSaturationLevel (double dVal)
 Sets the pre-synaptic saturation level. More...
 
double PreSynapticSaturationLevel ()
 Gets the pre-synaptic saturation level. More...
 
void PreSynapticThreshold (double dVal)
 Sets the pre-synaptic threshold. More...
 
double PreSynapticThreshold ()
 Gets the pre-synaptic threshold. More...
 
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 IntegrateFireSim::Synapses::SynapseType
 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 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

double m_dEquil
 The equilibruim potential.
 
double m_dSaturateV
 The saturation voltage.
 
double m_dSynAmp
 base syn amp, before vd or hebb
 
double m_dThreshV
 The threshold voltage.
 
- Protected Attributes inherited from IntegrateFireSim::Synapses::SynapseType
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..
 

Friends

class IntegrateFireSim::IntegrateFireNeuralModule
 

Detailed Description

Non-spiking chemical synapse type.

This synapse type changes its conductance in a graded manner based on the pre-synaptic neurons membrane potential. This emulates a steady release of neurotransmitter onto the post-synaptic cell.

Author
dcofer
Date
3/31/2011

Definition at line 23 of file NonSpikingChemicalSynapse.h.

Constructor & Destructor Documentation

IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::NonSpikingChemicalSynapse ( )

Default constructor.

Author
dcofer
Date
3/31/2011

Definition at line 22 of file NonSpikingChemicalSynapse.cpp.

References m_dEquil, m_dSaturateV, m_dSynAmp, and m_dThreshV.

IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::~NonSpikingChemicalSynapse ( )
virtual

Destructor.

Author
dcofer
Date
3/31/2011

Definition at line 36 of file NonSpikingChemicalSynapse.cpp.

Member Function Documentation

void IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::EquilibriumPotential ( double  dVal)

Sets the equilibrium potential.

Author
dcofer
Date
3/31/2011
Parameters
dValThe new value.

Definition at line 51 of file NonSpikingChemicalSynapse.cpp.

References m_dEquil.

double IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::EquilibriumPotential ( )

Gets the equilibrium potential.

Author
dcofer
Date
3/31/2011
Returns
equilibrium potential.

Definition at line 61 of file NonSpikingChemicalSynapse.cpp.

References m_dEquil.

Referenced by SetData().

+ Here is the caller graph for this function:

void IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::MaxSynapticConductance ( double  dVal)

Sets the maximum synaptic conductance.

Author
dcofer
Date
3/31/2011
Parameters
dValThe new value.

Definition at line 71 of file NonSpikingChemicalSynapse.cpp.

References m_dSynAmp.

double IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::MaxSynapticConductance ( )

Gets the maximum synaptic conductance.

Author
dcofer
Date
3/31/2011
Returns
synaptic conductance.

Definition at line 81 of file NonSpikingChemicalSynapse.cpp.

References m_dSynAmp.

Referenced by SetData().

+ Here is the caller graph for this function:

void IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::PreSynapticSaturationLevel ( double  dVal)

Sets the pre-synaptic saturation level.

Author
dcofer
Date
3/31/2011
Parameters
dValThe new value.

Definition at line 111 of file NonSpikingChemicalSynapse.cpp.

References m_dSaturateV.

double IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::PreSynapticSaturationLevel ( )

Gets the pre-synaptic saturation level.

Author
dcofer
Date
3/31/2011
Returns
saturation level.

Definition at line 121 of file NonSpikingChemicalSynapse.cpp.

References m_dSaturateV.

Referenced by SetData().

+ Here is the caller graph for this function:

void IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::PreSynapticThreshold ( double  dVal)

Sets the pre-synaptic threshold.

Author
dcofer
Date
3/31/2011
Parameters
dValThe new value.

Definition at line 91 of file NonSpikingChemicalSynapse.cpp.

References m_dThreshV.

double IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::PreSynapticThreshold ( )

Gets the pre-synaptic threshold.

Author
dcofer
Date
3/31/2011
Returns
pre-synaptic threshold.

Definition at line 101 of file NonSpikingChemicalSynapse.cpp.

References m_dThreshV.

Referenced by SetData().

+ Here is the caller graph for this function:

bool IntegrateFireSim::Synapses::NonSpikingChemicalSynapse::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 AnimatSim::AnimatBase.

Definition at line 127 of file NonSpikingChemicalSynapse.cpp.

References EquilibriumPotential(), MaxSynapticConductance(), PreSynapticSaturationLevel(), PreSynapticThreshold(), and StdUtils::Std_CheckString().

+ Here is the call graph for this function:


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