A class to represent columns. More...

#include <Column.h>

Inheritance diagram for nsol::Column:

Collaboration diagram for nsol::Column:

Public Member Functions
unsigned int	numberOfNeurons (const bool all=true, const Neuron::TMorphologicalType neuronType=Neuron::PYRAMIDAL, const unsigned int layer=0) const
	Method to get the number of neurons in the column. More...

virtual ColumnPtr	asColumn (void)

Constructors and destructors
	Column (unsigned short id=0)
	Default constructor. More...

	Column (const Column &other)
	Copy constructor. More...

virtual	~Column (void)
	Default destructur.

virtual ColumnStats *	stats (void)
	Returns object as MiniColumnStats. More...

Id related methods
unsigned short &	id (void)
	Method to get-set the column id. More...

unsigned short	id (void) const
	Method to get the column id. More...

MiniColumn related methods
void	addMiniColumn (MiniColumnPtr miniColumn)
	Method to add a mini column. More...

bool	removeMiniColumn (MiniColumnPtr miniColumn)
	Method to remove a mini column. More...

void	clearMiniColumns (void)
	Method to clear mini columns.

MiniColumns &	miniColumns (void)
	Method to get minicolumns. More...

MiniColumns	miniColumns (void) const
	Method to get minicolumns as const. More...

unsigned int	numberOfMiniColumns (void) const
	Method to get the number of minicolumns. More...

Operators
Column &	operator= (const Column &other)

bool	operator== (Column &other) const

bool	operator!= (Column &other) const

Public Member Functions inherited from nsol::Object
virtual MiniColumnPtr	asMiniColumn (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
	Identifier of the column.

MiniColumns	_miniColumns
	Container of minicolumns.

Detailed Description

A class to represent columns.

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

Definition at line 42 of file Column.h.

Constructor & Destructor Documentation

nsol::Column::Column ( unsigned short id = 0 )

Default constructor.

Parameters

id	id of the column.

nsol::Column::Column ( const Column & other )

Copy constructor.

Parameters

other column to be copied

Member Function Documentation

void nsol::Column::addMiniColumn ( MiniColumnPtr miniColumn )

Method to add a mini column.

Parameters

miniColumn minicolumn to add to this column

Referenced by nsol::XmlSceneReader::loadXml(), and stats().

Here is the caller graph for this function:

unsigned short& nsol::Column::id ( void )

Method to get-set the column id.

Returns: column id

Referenced by stats().

Here is the caller graph for this function:

unsigned short nsol::Column::id ( void ) const

Method to get the column id.

Returns: reference to column id

MiniColumns& nsol::Column::miniColumns ( void )

Method to get minicolumns.

Returns: minicolumns of the column

Referenced by stats().

Here is the caller graph for this function:

MiniColumns nsol::Column::miniColumns ( void ) const

Method to get minicolumns as const.

Returns: minicolumns of the column

unsigned int nsol::Column::numberOfMiniColumns ( void ) const

Method to get the number of minicolumns.

Returns: numbers of minicolumns

Referenced by stats().

Here is the caller graph for this function:

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

Method to get the number of neurons in the column.

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 later is 0 then all neurons of all layers will be counted.