nsol::NeuronMorphologySection Class Reference

Inheritance diagram for nsol::NeuronMorphologySection:

Collaboration diagram for nsol::NeuronMorphologySection:

Public Member Functions
	NeuronMorphologySection (void)
	Default constructor.
virtual	~NeuronMorphologySection ()
	Default destructor.
unsigned int	id (void) const
	Method to get the gid of the neuron morphology section. More...
void	id (unsigned int id)
	Method to set the gid of the neuron morphology section. More...
NeuritePtr	neurite (void)
	Gets the parent Neurite of the Neuron Morphology Section. More...
void	neurite (NeuritePtr neurite)
	Sets the parent neurite of this Neuron Morphology Section. More...
SectionPtr	parent (void)
	Gets the parent Section of this Section. More...
void	parent (SectionPtr parent)
	Sets the parent Section of this Section. More...
void	addChild (SectionPtr section)
	Adds child Section to this Section. More...
Sections &	children (void)
	Return the children sections. More...
const Sections &	children (void) const
virtual void	addNode (NodePtr node)
	Adds a Node at the end of Section. More...
NodePtr	firstNode (void)
	Gets the first Node of the Section. More...
virtual void	firstNode (NodePtr firstNode)
	Sets first Node of the Section. More...
NodePtr	lastNode (void)
	Gets the last Node of the Section. More...
virtual NeuronMorphologySectionStats *	stats (void)
	Returns object as SectionStats. More...
virtual SectionPtr	clone (void) const
virtual SectionPtr	asNeuronMorphologySection (void)
Public Member Functions inherited from nsol::Section
	Section (void)
	Default constructor.
virtual	~Section ()
	Default destructor.
Sections &	backwardNeighbors (void)
	Gets the backward neighbour sections of this section. More...
const Sections &	backwardNeighbors (void) const
Sections &	forwardNeighbors (void)
	Gets the forward neighbour sections of this section. More...
const Sections &	forwardNeighbors (void) const
void	addBackwardNeighbour (SectionPtr section)
	Adds backward neighbour section to this section. More...
void	addForwardNeighbour (SectionPtr section)
	Adds forward neighbour section to this section. More...
bool	deleteBackwardNeighbour (SectionPtr section_)
	Delete backward neighbour section from this section. More...
bool	deleteForwardNeighbour (SectionPtr section_)
	Delete forward neighbour section from this section. More...
void	addNeighbour (SectionPtr section, NodePtr node)
	Check if the node connects with the backward or the fordward neighbour sections and add the section to the correspondent sections container. More...
Nodes &	nodes (void)
	Return the middle Nodes. More...
const Nodes &	nodes (void) const
virtual void	addBackwardNode (NodePtr node)
	Adds a node at the start of this section. More...
virtual void	addForwardNode (NodePtr node)
	Adds a node at the end of this section. More...
NodePtr	backwardNode (void)
	Gets the first Node of the Section. More...
NodePtr	forwardNode (void)
	Gets the last Node of the Section. More...
bool	operator== (Section &other) const
bool	operator!= (Section &other) const
virtual SectionPtr	asSection (void)
Public Member Functions inherited from nsol::Object
virtual ColumnPtr	asColumn (void)
virtual MiniColumnPtr	asMiniColumn (void)
virtual NeuronPtr	asNeuron (void)
virtual NeuronMorphologyPtr	asNeuronMorphology (void)
virtual NodePtr	asNode (void)
virtual ObjectWithProperties *	properties (void)
virtual ObjectPtr	create (void)

Protected Attributes
unsigned int	_id
	Unique id.
NeuritePtr	_neurite
	Parent neurite of the section.
Protected Attributes inherited from nsol::Section
Nodes	_nodes
	Container of the middle nodes of this section.
Sections	_backwardSections
	Container of the backward neighbour sections of this section.
Sections	_forwardSections
	Container of the forward neighbour sections of this section.

Detailed Description

Definition at line 33 of file NeuronMorphologySection.h.

Member Function Documentation

void nsol::NeuronMorphologySection::addChild

(

SectionPtr

section

)

Adds child Section to this Section.

Parameters

section

pointer to the section to be added

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadNeurite().

Here is the caller graph for this function:

virtual void nsol::NeuronMorphologySection::addNode ( NodePtr  node )

virtual

Adds a Node at the end of Section.

Parameters

node	pointer to the Node to add. Precondition: pointer is not null.

Reimplemented in nsol::NeuronMorphologySectionCachedStats.

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadSection().

Here is the caller graph for this function:

Sections& nsol::NeuronMorphologySection::children

(

void

)

Return the children sections.

Returns

container of children sections

NodePtr nsol::NeuronMorphologySection::firstNode

(

void

)

Gets the first Node of the Section.

Returns

pointer to the first Node, null in case it doesn't have any

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadNeurite().

Here is the caller graph for this function:

virtual void nsol::NeuronMorphologySection::firstNode ( NodePtr  firstNode )

virtual

Sets first Node of the Section.

This method is virtual to allow reimplementation for cached objects and dirty state propagation

Parameters

firstNode

pointer to the Node.

Reimplemented in nsol::NeuronMorphologySectionCachedStats.

unsigned int nsol::NeuronMorphologySection::id

(

void

)

const

Method to get the gid of the neuron morphology section.

Returns

gid

void nsol::NeuronMorphologySection::id

(

unsigned int

id

)

Method to set the gid of the neuron morphology section.

Parameters

id

NodePtr nsol::NeuronMorphologySection::lastNode

(

void

)

Gets the last Node of the Section.

Returns

pointer to the last Node, null in case it doesn't have any

NeuritePtr nsol::NeuronMorphologySection::neurite

(

void

)

Gets the parent Neurite of the Neuron Morphology Section.

Returns

pointer to the parent Neurite

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadNeurite().

Here is the caller graph for this function:

void nsol::NeuronMorphologySection::neurite

(

NeuritePtr

neurite

)

Sets the parent neurite of this Neuron Morphology Section.

Parameters

neurite

pointer to parent neurite

SectionPtr nsol::NeuronMorphologySection::parent

(

void

)

Gets the parent Section of this Section.

Returns

pointer to the parent Section

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadNeurite(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::_ReadNeurite().

Here is the caller graph for this function:

void nsol::NeuronMorphologySection::parent

(

SectionPtr

parent

)

Sets the parent Section of this Section.

Parameters

parent

pointer to parent Section

virtual NeuronMorphologySectionStats* nsol::NeuronMorphologySection::stats ( void  )

virtual

Returns object as SectionStats.

Returns

pointer to SectionStats object

Reimplemented in nsol::NeuronMorphologySectionStats.

---

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

• NeuronMorphologySection.h