nsol  0.4.1
Nsol - Neuroscience Objects Library
nsol::Section Class Reference
+ Inheritance diagram for nsol::Section:
+ Collaboration diagram for nsol::Section:

Public Member Functions

 Section (void)
 Default constructor.
 
virtual ~Section ()
 Default destructor.
 
SectionsbackwardNeighbors (void)
 Gets the backward neighbour sections of this section. More...
 
const SectionsbackwardNeighbors (void) const
 
SectionsforwardNeighbors (void)
 Gets the forward neighbour sections of this section. More...
 
const SectionsforwardNeighbors (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...
 
Nodesnodes (void)
 Return the middle Nodes. More...
 
const Nodesnodes (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...
 
virtual SectionPtr clone (void) const
 
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 ObjectWithPropertiesproperties (void)
 
virtual ObjectPtr create (void)
 

Protected Attributes

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 34 of file Section.h.

Member Function Documentation

void nsol::Section::addBackwardNeighbour ( SectionPtr  section)

Adds backward neighbour section to this section.

Parameters
sectionpointer to the section to be added
virtual void nsol::Section::addBackwardNode ( NodePtr  node)
virtual

Adds a node at the start of this section.

Parameters
nodepointer to the Node to add. Precondition: pointer is not null.

Referenced by nsol::VectorsReaderTemplated< VECTORS_READER_TEMPLATE_CLASSES >::loadMorphology().

+ Here is the caller graph for this function:

void nsol::Section::addForwardNeighbour ( SectionPtr  section)

Adds forward neighbour section to this section.

Parameters
sectionpointer to the section to be added
virtual void nsol::Section::addForwardNode ( NodePtr  node)
virtual

Adds a node at the end of this section.

Parameters
nodepointer to the Node to add. Precondition: pointer is not null.

Referenced by nsol::VectorsReaderTemplated< VECTORS_READER_TEMPLATE_CLASSES >::loadMorphology().

+ Here is the caller graph for this function:

void nsol::Section::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.

Parameters
sectionpointer to the section to be added
nodepointer to the node between sections
Sections& nsol::Section::backwardNeighbors ( void  )

Gets the backward neighbour sections of this section.

Returns
container of the backward neighbour sections

Referenced by nsol::VectorsReaderTemplated< VECTORS_READER_TEMPLATE_CLASSES >::loadMorphology().

+ Here is the caller graph for this function:

NodePtr nsol::Section::backwardNode ( void  )

Gets the first Node of the Section.

Returns
pointer to the first Node, null in case it doesn't have any
bool nsol::Section::deleteBackwardNeighbour ( SectionPtr  section_)

Delete backward neighbour section from this section.

Parameters
sectionpointer to the section to be deleted
Returns
true if the given section is in the backward sections
bool nsol::Section::deleteForwardNeighbour ( SectionPtr  section_)

Delete forward neighbour section from this section.

Parameters
sectionpointer to the section to be deleted
Returns
true if the given section is in the forward sections
Sections& nsol::Section::forwardNeighbors ( void  )

Gets the forward neighbour sections of this section.

Returns
container of the forward neighbour sections

Referenced by nsol::VectorsReaderTemplated< VECTORS_READER_TEMPLATE_CLASSES >::loadMorphology().

+ Here is the caller graph for this function:

NodePtr nsol::Section::forwardNode ( void  )

Gets the last Node of the Section.

Returns
pointer to the first Node, null in case it doesn't have any
Nodes& nsol::Section::nodes ( void  )

Return the middle Nodes.

Returns
container of middle Nodes

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