nsol::Synapse Class Reference

A class to represent synapses. More...

#include <Synapse.h>

Inheritance diagram for nsol::Synapse:

Collaboration diagram for nsol::Synapse:

Public Member Functions
Constructors and destructors
	Synapse (void)
	Default Synapse constructor.
	Synapse (const Synapse &other_)
	Copy constructor. More...
virtual	~Synapse (void)
	Default destructor.
getters and setters methods
uint32_t	preSynapticNeuron (void) const
	Method to get the gid of the presynaptic neuron. More...
void	preSynapticNeuron (const uint32_t neuronID_)
	Method to add a presynaptic neuron to the synapse. More...
uint32_t	postSynapticNeuron (void) const
	Method to get the gid of the postsynaptic neuron. More...
void	postSynapticNeuron (const uint32_t neuronID_)
	Method to add a postsynaptic neuron to the synapse. More...
void	weight (const float weight_)
	Method to set the synaptic weight. More...
float	weight (void) const
	Method to get the synaptic weight. More...
Synapse &	operator= (const Synapse &)=default
	Operator =. More...

Protected Attributes
uint32_t	_preSynapticNeuron
	GID Presynaptic neuron.
uint32_t	_postSynapticNeuron
	GID Postsynaptic neuron.
float	_weight
	The synaptic weight.

Detailed Description

A class to represent synapses.

TODO: extend long description

Definition at line 38 of file Synapse.h.

Constructor & Destructor Documentation

nsol::Synapse::Synapse

(

const Synapse &

other_

)

Copy constructor.

Parameters

other_

synapse to be copied

Member Function Documentation

Synapse& nsol::Synapse::operator= ( const Synapse &  )

default

Operator =.

Included to avoid warning in modern gcc versions.

uint32_t nsol::Synapse::postSynapticNeuron

(

void

)

const

Method to get the gid of the postsynaptic neuron.

Returns

gid of the postsynaptic neuron.

void nsol::Synapse::postSynapticNeuron

(

const uint32_t

neuronID_

)

Method to add a postsynaptic neuron to the synapse.

Parameters

neuronID_

gid of the postsynaptic neuron.

See also

Neuron

uint32_t nsol::Synapse::preSynapticNeuron

(

void

)

const

Method to get the gid of the presynaptic neuron.

Returns

gid of the presynaptic neuron.

void nsol::Synapse::preSynapticNeuron

(

const uint32_t

neuronID_

)

Method to add a presynaptic neuron to the synapse.

Parameters

neuronID_

gid of the presynaptic neuron.

See also

Neuron

void nsol::Synapse::weight

(

const float

weight_

)

Method to set the synaptic weight.

Parameters

weight_

synaptic weight.

float nsol::Synapse::weight

(

void

)

const

Method to get the synaptic weight.

Returns

synaptic weight.

---

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

• Synapse.h