BioDynaMo  v1.03.58-27764645
Public Member Functions | List of all members
bdm::neuroscience::NeuronOrNeurite Class Referenceabstract

#include <neuron_or_neurite.h>

Inheritance diagram for bdm::neuroscience::NeuronOrNeurite:

Public Member Functions

virtual ~NeuronOrNeurite ()
virtual const AgentUidGetUid () const =0
virtual SpinlockGetLock ()=0
AgentPointer< NeuronOrNeuriteGetNeuronOrNeuriteAgentPtr () const
virtual StructureIdentifierSWC GetIdentifierSWC () const
 Returns the SWC classification of the object. More...
bool IsNeuronSoma () const
bool IsNeuriteElement () const
virtual Real3 OriginOf (const AgentUid &daughter_uid) const =0
virtual void RemoveDaughter (const AgentPointer< NeuriteElement > &daughter)=0
virtual void UpdateDependentPhysicalVariables ()=0
virtual void UpdateRelative (const NeuronOrNeurite &old_rel, const NeuronOrNeurite &new_rel)=0

Detailed Description

The mother of a neurite element can either be a neuron or a neurite. This class declares this interface.

Definition at line 42 of file neuron_or_neurite.h.

Constructor & Destructor Documentation

◆ ~NeuronOrNeurite()

bdm::neuroscience::NeuronOrNeurite::~NeuronOrNeurite ( )

Member Function Documentation

◆ GetIdentifierSWC()

StructureIdentifierSWC bdm::neuroscience::NeuronOrNeurite::GetIdentifierSWC ( ) const

Returns the SWC classification of the object.

See also
StructureIdentifierSWC. Returns StructureIdentifierSWC:kSoma for the Soma and StructureIdentifierSWC::kApicalDendrite for all other objects. May be modified in child classes.

Reimplemented in bdm::neuroscience::NeuriteElement.

Definition at line 35 of file

◆ GetLock()

virtual Spinlock* bdm::neuroscience::NeuronOrNeurite::GetLock ( )
pure virtual

◆ GetNeuronOrNeuriteAgentPtr()

AgentPointer< NeuronOrNeurite > bdm::neuroscience::NeuronOrNeurite::GetNeuronOrNeuriteAgentPtr ( ) const

Definition at line 24 of file

◆ GetUid()

virtual const AgentUid& bdm::neuroscience::NeuronOrNeurite::GetUid ( ) const
pure virtual

◆ IsNeuriteElement()

bool bdm::neuroscience::NeuronOrNeurite::IsNeuriteElement ( ) const

Definition at line 47 of file

◆ IsNeuronSoma()

bool bdm::neuroscience::NeuronOrNeurite::IsNeuronSoma ( ) const

Definition at line 43 of file

◆ OriginOf()

virtual Real3 bdm::neuroscience::NeuronOrNeurite::OriginOf ( const AgentUid daughter_uid) const
pure virtual

◆ RemoveDaughter()

virtual void bdm::neuroscience::NeuronOrNeurite::RemoveDaughter ( const AgentPointer< NeuriteElement > &  daughter)
pure virtual

◆ UpdateDependentPhysicalVariables()

virtual void bdm::neuroscience::NeuronOrNeurite::UpdateDependentPhysicalVariables ( )
pure virtual

◆ UpdateRelative()

virtual void bdm::neuroscience::NeuronOrNeurite::UpdateRelative ( const NeuronOrNeurite old_rel,
const NeuronOrNeurite new_rel 
pure virtual

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