Inheritance diagram for IntegrateFireSim::Synapses::ElectricalSynapse:

Collaboration diagram for IntegrateFireSim::Synapses::ElectricalSynapse:

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

virtual	~ElectricalSynapse ()
	Destructor. More...

void	HighCoupling (double dVal)
	Sets the high coupling voltage. More...

double	HighCoupling ()
	Gets the high coupling voltage. More...

virtual void	Load (CStdXml &oXml)

void	LowCoupling (double dVal)
	Sets the low coupling voltage. More...

double	LowCoupling ()
	Gets the low coupling voltage. 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...

void	TurnOnSaturate (double dVal)
	Sets the turn-on saturation voltage. More...

double	TurnOnSaturate ()
	Gets the turn-on saturation voltage. More...

void	TurnOnThreshold (double dVal)
	Sets the turn-on threshold voltage. More...

double	TurnOnThreshold ()
	Gets the turn-on threshold voltage. 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 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 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_dHiCoup
	The hi coupling voltage.

double	m_dLowCoup
	The low coupling voltage.

double	m_dSaturateV
	The saturation voltage level.

double	m_dTurnOnV
	The turn on voltage level.

Protected Attributes inherited from IntegrateFireSim::Synapses::SynapseType
int	m_iSynapseTypeID
	Integre ID for the synapse type.

IntegrateFireNeuralModule *	m_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::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..

Friends
class	IntegrateFireSim::IntegrateFireNeuralModule

Detailed Description

Definition at line 14 of file ElectricalSynapse.h.

Constructor & Destructor Documentation

IntegrateFireSim::Synapses::ElectricalSynapse::ElectricalSynapse ( )

Default constructor.

Author: dcofer

Date: 3/31/2011

Definition at line 22 of file ElectricalSynapse.cpp.

References m_dHiCoup, m_dLowCoup, m_dSaturateV, and m_dTurnOnV.

IntegrateFireSim::Synapses::ElectricalSynapse::~ElectricalSynapse ( )

virtual

Destructor.

Author: dcofer

Date: 3/31/2011

Definition at line 36 of file ElectricalSynapse.cpp.

Member Function Documentation

void IntegrateFireSim::Synapses::ElectricalSynapse::HighCoupling ( double dVal )

Sets the high coupling voltage.

Author: dcofer

Date: 3/31/2011

Parameters

dVal	The new value.

Definition at line 71 of file ElectricalSynapse.cpp.

References m_dHiCoup.

double IntegrateFireSim::Synapses::ElectricalSynapse::HighCoupling ( )

Gets the high coupling voltage.

Author: dcofer

Date: 3/31/2011

Returns: high coupling voltage.

Definition at line 81 of file ElectricalSynapse.cpp.

References m_dHiCoup.

Referenced by SetData().

Here is the caller graph for this function:

void IntegrateFireSim::Synapses::ElectricalSynapse::LowCoupling ( double dVal )

Sets the low coupling voltage.

Author: dcofer

Date: 3/31/2011

Parameters

dVal	The new value.

Definition at line 51 of file ElectricalSynapse.cpp.

References m_dLowCoup.

double IntegrateFireSim::Synapses::ElectricalSynapse::LowCoupling ( )

Gets the low coupling voltage.

Author: dcofer

Date: 3/31/2011

Returns: low coupling voltage.

Definition at line 61 of file ElectricalSynapse.cpp.

References m_dLowCoup.

Referenced by SetData().

Here is the caller graph for this function:

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

Definition at line 127 of file ElectricalSynapse.cpp.

References HighCoupling(), LowCoupling(), StdUtils::Std_CheckString(), TurnOnSaturate(), and TurnOnThreshold().

Here is the call graph for this function:

void IntegrateFireSim::Synapses::ElectricalSynapse::TurnOnSaturate ( double dVal )

Sets the turn-on saturation voltage.

Author: dcofer

Date: 3/31/2011

Parameters

dVal	The new value.

Definition at line 111 of file ElectricalSynapse.cpp.

References m_dSaturateV.

double IntegrateFireSim::Synapses::ElectricalSynapse::TurnOnSaturate ( )

Gets the turn-on saturation voltage.

Author: dcofer

Date: 3/31/2011

Returns: saturation voltage.

Definition at line 121 of file ElectricalSynapse.cpp.

References m_dSaturateV.

Referenced by SetData().

Here is the caller graph for this function:

void IntegrateFireSim::Synapses::ElectricalSynapse::TurnOnThreshold ( double dVal )

Sets the turn-on threshold voltage.

Author: dcofer

Date: 3/31/2011

Parameters

dVal	The new value.

Definition at line 91 of file ElectricalSynapse.cpp.

References m_dTurnOnV.

double IntegrateFireSim::Synapses::ElectricalSynapse::TurnOnThreshold ( )

Gets the turn-on threshold voltage.

Author: dcofer

Date: 3/31/2011

Returns: threshold voltage.

Definition at line 101 of file ElectricalSynapse.cpp.

References m_dTurnOnV.

Referenced by SetData().

Here is the caller graph for this function:

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

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation