nsol::Circuit Class Reference

A class to represent connections between neurons. TODO: extend long description. More...

#include <Circuit.h>

Collaboration diagram for nsol::Circuit:

Public Types
enum	TDataType { ALL = 0, PRESYNAPTICCONNECTIONS, POSTSYNAPTICCONNECTIONS }
	Possible types of data to get.

Public Member Functions
Constructors and destructors
	Circuit (void)
	Default constructor.
virtual	~Circuit (void)
	Default destructor.
Connections related methods
void	addSynapse (SynapsePtr synapse_)
	Method to add a connection into the cirtuit. More...
void	addSynapses (const std::vector< SynapsePtr > &synapses)
void	addSynapses (const std::vector< MorphologySynapsePtr > &synapses)
void	clear (void)
	Method to clear all the connections of all the circuit.
unsigned int	numberOfSynapses (void) const
	Method to get the total number of connections of the circuit. More...
Afferent & Efferent synapses related methods
const std::vector< SynapsePtr > &	synapses (void) const
	Method to get all the synapses from the circuit. More...
std::set< SynapsePtr >	synapses (TDataType dataType_) const
	Method to get all the synapses from the circuit. More...
std::set< SynapsePtr >	synapses (uint32_t neuronGID_, TDataType dataType_) const
	Method to get all the sinapses of the neuron into the circuit. More...
std::set< SynapsePtr >	synapses (const std::set< uint32_t > &gidsNeurons_, TDataType dataType_) const
	Method to get all the sinapses from a subset of neurons. More...

Protected Attributes
std::vector< SynapsePtr >	_synapses
	Container with all the connections between neurons.
SynapsesMap	_preSynapticConnections
	Container with all the efferents connections into the circuit.
SynapsesMap	_postSynapticConnections
	Container with all the afferents connections into the circuit.

Detailed Description

A class to represent connections between neurons. TODO: extend long description.

Definition at line 40 of file Circuit.h.

Member Function Documentation

void nsol::Circuit::addSynapse

(

SynapsePtr

synapse_

)

Method to add a connection into the cirtuit.

Parameters

synapse_

synapse to add to this circuit

unsigned int nsol::Circuit::numberOfSynapses

(

void

)

const

Method to get the total number of connections of the circuit.

Returns

total numbers of synapses

const std::vector< SynapsePtr >& nsol::Circuit::synapses

(

void

)

const

Method to get all the synapses from the circuit.

Returns

vector with all the ordered synapses by its gid

std::set< SynapsePtr > nsol::Circuit::synapses

(

TDataType

dataType_

)

const

Method to get all the synapses from the circuit.

Parameters

dataType_

Data type

Returns

subset with all the synapses

std::set< SynapsePtr > nsol::Circuit::synapses	(	uint32_t	neuronGID_,
		TDataType	dataType_
	)		const

Method to get all the sinapses of the neuron into the circuit.

Parameters

neuronGID_	neuron id
dataType_	Data type

Returns

all the synapses of this neuron.

std::set< SynapsePtr > nsol::Circuit::synapses	(	const std::set< uint32_t > &	gidsNeurons_,
		TDataType	dataType_
	)		const

Method to get all the sinapses from a subset of neurons.

Parameters

gidsNeurons_	subset of ids neurons
dataType_	Data type

Returns

all the synapses of this subset of neurons.

---

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

• Circuit.h