BioDynaMo  v1.05.120-25dc9790
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bdm::neuroscience::NewNeuriteExtensionEvent Struct Reference

Contains the parameters to extend a new neurite from a neuron soma. More...

#include <new_neurite_extension_event.h>

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

Public Member Functions

 NewNeuriteExtensionEvent (real_t diameter, real_t phi, real_t theta)
 
 ~NewNeuriteExtensionEvent () override=default
 
NewAgentEventUid GetUid () const override
 
- Public Member Functions inherited from bdm::NewAgentEvent
virtual ~NewAgentEvent ()=default
 

Public Attributes

real_t diameter
 diameter the diameter of the new neurite More...
 
real_t phi
 phi azimuthal angle (spherical coordinates) More...
 
real_t theta
 theta polar angle (spherical coordinates) More...
 
- 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 extend a new neurite from a neuron soma.

The cell that triggers the event is the neuron soma. The event creates a new neurite element.

Definition at line 27 of file new_neurite_extension_event.h.

Constructor & Destructor Documentation

◆ NewNeuriteExtensionEvent()

bdm::neuroscience::NewNeuriteExtensionEvent::NewNeuriteExtensionEvent ( real_t  diameter,
real_t  phi,
real_t  theta 
)
inline

Definition at line 30 of file new_neurite_extension_event.h.

◆ ~NewNeuriteExtensionEvent()

bdm::neuroscience::NewNeuriteExtensionEvent::~NewNeuriteExtensionEvent ( )
overridedefault

Member Function Documentation

◆ GetUid()

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

Implements bdm::NewAgentEvent.

Definition at line 35 of file new_neurite_extension_event.h.

Member Data Documentation

◆ diameter

real_t bdm::neuroscience::NewNeuriteExtensionEvent::diameter

diameter the diameter of the new neurite

Definition at line 38 of file new_neurite_extension_event.h.

◆ kUid

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

Definition at line 28 of file new_neurite_extension_event.h.

◆ phi

real_t bdm::neuroscience::NewNeuriteExtensionEvent::phi

phi azimuthal angle (spherical coordinates)

Definition at line 40 of file new_neurite_extension_event.h.

◆ theta

real_t bdm::neuroscience::NewNeuriteExtensionEvent::theta

theta polar angle (spherical coordinates)

Definition at line 42 of file new_neurite_extension_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