BioDynaMo  v1.03.58-27764645
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bdm::neuroscience::SplitNeuriteElementEvent Struct Reference

Contains the parameters to split a neurite element into two segments. More...

#include <split_neurite_element_event.h>

Inheritance diagram for bdm::neuroscience::SplitNeuriteElementEvent:
[legend]
Collaboration diagram for bdm::neuroscience::SplitNeuriteElementEvent:
[legend]

Public Member Functions

 SplitNeuriteElementEvent (real_t distal_portion)
 
virtual ~SplitNeuriteElementEvent ()=default
 
NewAgentEventUid GetUid () const override
 
- Public Member Functions inherited from bdm::NewAgentEvent
virtual ~NewAgentEvent ()=default
 

Public Attributes

real_t distal_portion
 
- Public Attributes inherited from bdm::NewAgentEvent
Agentexisting_agent
 
InlineVector< Agent *, 3 > new_agents
 
Behaviorexisting_behavior
 
InlineVector< Behavior *, 3 > new_behaviors
 

Static Public Attributes

static const NewAgentEventUid kUid
 

Detailed Description

Contains the parameters to split a neurite element into two segments.

This event splits a neurite element into two segments. The neurite element that triggers the event becomes the distal one. The new neurite element will be the proximal one.

Definition at line 28 of file split_neurite_element_event.h.

Constructor & Destructor Documentation

◆ SplitNeuriteElementEvent()

bdm::neuroscience::SplitNeuriteElementEvent::SplitNeuriteElementEvent ( real_t  distal_portion)
inlineexplicit

Definition at line 31 of file split_neurite_element_event.h.

◆ ~SplitNeuriteElementEvent()

virtual bdm::neuroscience::SplitNeuriteElementEvent::~SplitNeuriteElementEvent ( )
virtualdefault

Member Function Documentation

◆ GetUid()

NewAgentEventUid bdm::neuroscience::SplitNeuriteElementEvent::GetUid ( ) const
inlineoverridevirtual

Implements bdm::NewAgentEvent.

Definition at line 36 of file split_neurite_element_event.h.

Member Data Documentation

◆ distal_portion

real_t bdm::neuroscience::SplitNeuriteElementEvent::distal_portion

The fraction of the total old length devoted to the distal half (should be between 0 and 1).

Definition at line 40 of file split_neurite_element_event.h.

◆ kUid

const NewAgentEventUid bdm::neuroscience::SplitNeuriteElementEvent::kUid
static
Initial value:

Definition at line 29 of file split_neurite_element_event.h.


The documentation for this struct was generated from the following files:
bdm::NewAgentEventUidGenerator::GenerateUid
NewAgentEventUid GenerateUid()
Definition: new_agent_event.h:44
bdm::NewAgentEventUidGenerator::GetInstance
static NewAgentEventUidGenerator * GetInstance()
Definition: new_agent_event.cc:23