nsol::MiniColumn Class Reference

A class to represent minicolumns. More...

#include <MiniColumn.h>

Inheritance diagram for nsol::MiniColumn:

Collaboration diagram for nsol::MiniColumn:

Public Member Functions
virtual MiniColumnStats *	stats (void)
	Returns object as MiniColumnStats. More...
virtual MiniColumnPtr	asMiniColumn (void)
Constructors and destructors
	MiniColumn (const ColumnPtr column=nullptr, const unsigned short id=0)
	Default constructor. More...
	MiniColumn (const MiniColumn &other)
	Copy constructor. More...
virtual	~MiniColumn ()
	Default destructur.
Id related methods
unsigned short &	id (void)
	Method to get-set mini column id. More...
unsigned short	id (void) const
	Method to get the column id as const. More...
Column related methods
void	column (ColumnPtr column)
	Method to set the column of this minicolumn. More...
ColumnPtr	column (void) const
	Method to get the column of this minicolumn. More...
Neuron related methods
NeuronPtr	addNeuron (NeuronPtr neuron)
	Method to add a neuron. More...
bool	removeNeuron (NeuronPtr neuron)
	Method to remove a neuron. More...
Neurons &	neurons (void)
	Method to get neurons. More...
Neurons	neurons (void) const
	Method to get neurons. More...
void	clearNeurons (void)
	Method to clear the neurons container.
unsigned int	numberOfNeurons (bool all=true, Neuron::TMorphologicalType neuronType=Neuron::PYRAMIDAL, unsigned int layer=0) const
	Method to get the number of neurons in the minicolumn. More...
Operators
MiniColumn &	operator= (const MiniColumn &other)
bool	operator== (MiniColumn &other) const
bool	operator!= (MiniColumn &other) const
Public Member Functions inherited from nsol::Object
virtual ColumnPtr	asColumn (void)
virtual NeuronPtr	asNeuron (void)
virtual NeuronMorphologyPtr	asNeuronMorphology (void)
virtual SectionPtr	asSection (void)
virtual NodePtr	asNode (void)
virtual ObjectWithProperties *	properties (void)
virtual ObjectPtr	create (void)

Protected Attributes
unsigned short	_id
	id of this minicolumn
ColumnPtr	_column
	Pointer to the column this minicolumn belogns to.
Neurons	_neurons
	! Container of the neurons of this minicolumn

Detailed Description

A class to represent minicolumns.

Columns provides pointers to neurons and methods for different morphological values computation.

Definition at line 41 of file MiniColumn.h.

Constructor & Destructor Documentation

nsol::MiniColumn::MiniColumn	(	const ColumnPtr	column = nullptr,
		const unsigned short	id = 0
	)

Default constructor.

Parameters

column	pointer to parent column.
id	id of the minicolumn.

nsol::MiniColumn::MiniColumn

(

const MiniColumn &

other

)

Copy constructor.

Parameters

other

column to be copied

Member Function Documentation

NeuronPtr nsol::MiniColumn::addNeuron

(

NeuronPtr

neuron

)

Method to add a neuron.

If null value passed a new neuron is created

Parameters

neuron

pointer to neuron to add. If null new neuron is created

Returns

pointer to the added neuron

Referenced by nsol::XmlSceneReader::loadXml().

Here is the caller graph for this function:

void nsol::MiniColumn::column

(

ColumnPtr

column

)

Method to set the column of this minicolumn.

Parameters

column

pointer to the column

ColumnPtr nsol::MiniColumn::column

(

void

)

const

Method to get the column of this minicolumn.

Returns

pointer to the column

unsigned short& nsol::MiniColumn::id

(

void

)

Method to get-set mini column id.

Returns

refenrence to mini column id

unsigned short nsol::MiniColumn::id

(

void

)

const

Method to get the column id as const.

Returns

id of the minicolumn

Neurons& nsol::MiniColumn::neurons

(

void

)

Method to get neurons.

Returns

neurons of the mimi column

Neurons nsol::MiniColumn::neurons

(

void

)

const

Method to get neurons.

Returns

neurons of the mimi column

unsigned int nsol::MiniColumn::numberOfNeurons	(	bool	all = true,
		Neuron::TMorphologicalType	neuronType = Neuron::PYRAMIDAL,
		unsigned int	layer = 0
	)		const

Method to get the number of neurons in the minicolumn.

Parameters

all	if this is true all neurons are counted
neuronType	if "all" is false neurons of the passed type will be counted
layer	if "all" is false neurons of the layer will be counted. If layer is 0 then all neurons of all layers will be counted.

Returns

number of neurons that match the criteria

bool nsol::MiniColumn::removeNeuron

(

NeuronPtr

neuron

)

Method to remove a neuron.

Parameters

neuron

pointer to the neuron to be removed

Returns

true if neuron removed false otherwise

virtual MiniColumnStats* nsol::MiniColumn::stats ( void  )

inlinevirtual

Returns object as MiniColumnStats.

Returns

pointer to MiniColumnStats object

Reimplemented in nsol::MiniColumnStats.

Definition at line 191 of file MiniColumn.h.

---

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

• MiniColumn.h