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

Public Member Functions

 NeuronMorphologySectionCachedStats (void)
 Stats that can be cached for NeuronMorphologySectionStats. More...
 
virtual ~NeuronMorphologySectionCachedStats (void)
 Default destructor.
 
virtual void setAndPropagateDirty (unsigned int id_)
 Set dirty a cached stat and propagates dirty to parent neurite. More...
 
virtual void setAndPropagateDirty (void)
 Set dirty all cached stats and propagates dirty to parent neurite.
 
virtual void addNode (NodePtr node=nullptr)
 Adds a node at the end of the section. More...
 
virtual void firstNode (NodePtr firstNode_)
 Sets first Node of the Section. More...
 
virtual float getStat (TNeuronMorphologySectionStat stat) const
 
- Public Member Functions inherited from nsol::NeuronMorphologySectionStats
NeuronMorphologySectionStatsstats (void)
 Returns object as SectionStats. More...
 
virtual float getStat (TNeuronMorphologySectionStat stat, TAggregation agg=TOTAL) const
 
- Public Member Functions inherited from nsol::NeuronMorphologySection
 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...
 
Sectionschildren (void)
 Return the children sections. More...
 
const Sectionschildren (void) const
 
NodePtr firstNode (void)
 Gets the first Node of the Section. More...
 
NodePtr lastNode (void)
 Gets the last Node of the Section. 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.
 
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...
 
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)
 
- Public Member Functions inherited from nsol::Cached<>
bool dirty (unsigned int id_) const
 
void setDirty (unsigned int id_)
 
void setDirty (void)
 
void cacheValue (const unsigned int id_, floatvalue_) const
 
float getValue (const unsigned int id_) const
 

Additional Inherited Members

- Public Types inherited from nsol::NeuronMorphologySectionStats
enum  TNeuronMorphologySectionStat {
  SURFACE = 0, VOLUME, LENGTH, RADIUS,
  NEURON_MORPHOLOGY_SECTION_NUM_STATS
}
 Stats that can be computed for Section.
 
- Protected Attributes inherited from nsol::NeuronMorphologySection
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.
 
- Protected Attributes inherited from nsol::Cached<>
std::map< unsigned int, float > _values
 Container of the cached values. Is mutable to allow const methods to modify the cache if needed.
 

Detailed Description

Definition at line 45 of file NeuronMorphologySectionCachedStats.h.

Constructor & Destructor Documentation

nsol::NeuronMorphologySectionCachedStats::NeuronMorphologySectionCachedStats ( void  )

Stats that can be cached for NeuronMorphologySectionStats.

Default constructor

Member Function Documentation

virtual void nsol::NeuronMorphologySectionCachedStats::addNode ( NodePtr  node = nullptr)
virtual

Adds a node at the end of the section.

This method does the same as Section::addNode but it also sets dirty all stats of parent neurite.

Parameters
nodepointer to the node to add. Precondition: pointer is not null.
Returns
pointer to the node added (for compatibility with older nsol versions)

Reimplemented from nsol::NeuronMorphologySection.

virtual void nsol::NeuronMorphologySectionCachedStats::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
firstNodepointer to the Node.

Reimplemented from nsol::NeuronMorphologySection.

virtual void nsol::NeuronMorphologySectionCachedStats::setAndPropagateDirty ( unsigned int  id_)
virtual

Set dirty a cached stat and propagates dirty to parent neurite.

Parameters
id_identifier of the property to set dirty. It also propagates dirty state to parent neurite. id value has to be one from TNeuronMorphologySectionCachedValues (checked only on debug compiling).

Reimplemented from nsol::Cached<>.


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