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:

Collaboration diagram for bdm::neuroscience::SplitNeuriteElementEvent:

Public Member Functions
	SplitNeuriteElementEvent (real_t distal_portion)
	~SplitNeuriteElementEvent () override=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
Agent *	existing_agent
InlineVector< Agent *, 3 >	new_agents
Behavior *	existing_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()

bdm::neuroscience::SplitNeuriteElementEvent::~SplitNeuriteElementEvent ( )

overridedefault

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:

=
    NewAgentEventUidGenerator::GetInstance()->GenerateUid()

Definition at line 29 of file split_neurite_element_event.h.

---

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

• neuroscience/new_agent_event/split_neurite_element_event.h
• neuroscience/new_agent_event/new_agent_event.cc