nsol::MorphologySynapse Class Reference

Inheritance diagram for nsol::MorphologySynapse:

Collaboration diagram for nsol::MorphologySynapse:

Public Types
enum	TSynapseType {   UNDEFINED = 0, DENDRODENDRITIC, AXODENDRITIC, AXOAXONIC,   SOMATOSOMATIC, AXOSOMATIC, DENDROSOMATIC }
	Possible types of synapse.
enum	TSynapticSectionType { PRESYNAPTICSECTION = 0, POSTSYNAPTICSECTION }
	Possible types of synaptic section.

Public Member Functions
Constructors and destructors
	MorphologySynapse (void)
	Default MorphologySynapse constructor.
	MorphologySynapse (const MorphologySynapse &other_)
	Copy constructor. More...
virtual	~MorphologySynapse (void)
	Default destructor.
getters and setters methods
unsigned int	gid (void) const
	GID getter.
void	gid (unsigned int gid_)
	GID setter. More...
TSynapseType	synapseType (void) const
	Method to get the type of the synapse.
Vec3f	preSynapticSurfacePosition (void) const
	Method to get the presynaptic surface position. More...
void	preSynapticSurfacePosition (const Vec3f &presynaptic_surface_position_)
	Method to set presynaptic surface position to the synapse. More...
Vec3f	postSynapticSurfacePosition (void) const
	Method to get the postsynaptic surface position. More...
void	postSynapticSurfacePosition (const Vec3f &position_)
	Method to set postsynaptic surface position to the synapse. More...
void	preSynapticSection (const NeuronMorphologySectionPtr preSynapticSection_)
	Method to add a presynaptic section to the synapse. More...
NeuronMorphologySectionPtr	preSynapticSection (void) const
	Method to get the presynaptic section. More...
void	postSynapticSection (const NeuronMorphologySectionPtr section_)
	Method to add a postsynaptic section to the synapse. More...
NeuronMorphologySectionPtr	postSynapticSection (void) const
	Method to get the postsynaptic section. More...
MorphologySynapse &	operator= (const nsol::MorphologySynapse &)=default
	Operator =. More...
Public Member Functions inherited from nsol::Synapse
	Synapse (void)
	Default Synapse constructor.
	Synapse (const Synapse &other_)
	Copy constructor. More...
virtual	~Synapse (void)
	Default destructor.
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
unsigned int	_gid
	Synapse GID (default value zero)
Vec3f	_preSynapticSurfacePosition
	Presynaptic surface position.
Vec3f	_postSynapticSurfacePosition
	Postsynaptic surface position.
NeuronMorphologySectionPtr	_preSynapticSection
	Section of a presynaptic neuron (neurite)
NeuronMorphologySectionPtr	_postSynapticSection
	Section of a postsynaptic neuron (neurite)
Protected Attributes inherited from nsol::Synapse
uint32_t	_preSynapticNeuron
	GID Presynaptic neuron.
uint32_t	_postSynapticNeuron
	GID Postsynaptic neuron.
float	_weight
	The synaptic weight.

Detailed Description

Definition at line 34 of file MorphologySynapse.h.

Constructor & Destructor Documentation

nsol::MorphologySynapse::MorphologySynapse

(

const MorphologySynapse &

other_

)

Copy constructor.

Parameters

other_

MorphologySynapseto be copied

Member Function Documentation

void nsol::MorphologySynapse::gid

(

unsigned int

gid_

)

GID setter.

Note: Zero as default value.

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

default

Operator =.

Included to avoid warning in modern gcc versions.

void nsol::MorphologySynapse::postSynapticSection

(

const NeuronMorphologySectionPtr

section_

)

Method to add a postsynaptic section to the synapse.

Parameters

section_

postsynaptic section.

See also

Synapse

NeuronMorphologySectionPtr nsol::MorphologySynapse::postSynapticSection

(

void

)

const

Method to get the postsynaptic section.

Returns

pointer to the postsynaptic section.

Vec3f nsol::MorphologySynapse::postSynapticSurfacePosition

(

void

)

const

Method to get the postsynaptic surface position.

Returns

postsynaptic surface position.

void nsol::MorphologySynapse::postSynapticSurfacePosition

(

const Vec3f &

position_

)

Method to set postsynaptic surface position to the synapse.

Parameters

position_

postsynaptic surface position.

void nsol::MorphologySynapse::preSynapticSection

(

const NeuronMorphologySectionPtr

preSynapticSection_

)

Method to add a presynaptic section to the synapse.

Parameters

preSynapticSection_

presynaptic section.

See also

Synapse

NeuronMorphologySectionPtr nsol::MorphologySynapse::preSynapticSection

(

void

)

const

Method to get the presynaptic section.

Returns

pointer to the presynaptic section.

Vec3f nsol::MorphologySynapse::preSynapticSurfacePosition

(

void

)

const

Method to get the presynaptic surface position.

Returns

presynaptic surface position.

void nsol::MorphologySynapse::preSynapticSurfacePosition

(

const Vec3f &

presynaptic_surface_position_

)

Method to set presynaptic surface position to the synapse.

Parameters

presynaptic_surface_position_

presynaptic surface position.

---

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

• MorphologySynapse.h