BioDynaMo  v1.03.58-27764645
Public Member Functions | Private Member Functions | Private Attributes | List of all members
bdm::Secretion Class Reference

Secrete substance at Agent position. More...

#include <secretion.h>

Inheritance diagram for bdm::Secretion:
[legend]
Collaboration diagram for bdm::Secretion:
[legend]

Public Member Functions

 Secretion ()=default
 
 Secretion (const std::string &substance, real_t quantity=1)
 
 Secretion (DiffusionGrid *dgrid, real_t quantity=1)
 
virtual ~Secretion ()=default
 
void Initialize (const NewAgentEvent &event) override
 
void Run (Agent *agent) override
 
- Public Member Functions inherited from bdm::Behavior
 Behavior ()
 
virtual ~Behavior ()=default
 
virtual BehaviorNew () const =0
 Create a new instance of this object using the default constructor. More...
 
virtual BehaviorNewCopy () const =0
 Create a new copy of this behavior. More...
 
virtual void Update (const NewAgentEvent &event)
 
void AlwaysCopyToNew ()
 Always copy this behavior to new agents. More...
 
void NeverCopyToNew ()
 Never copy this behavior to new agents. More...
 
void CopyToNewIf (const std::initializer_list< NewAgentEventUid > &uids)
 
void AlwaysRemoveFromExisting ()
 
void NeverRemoveFromExisting ()
 
void RemoveFromExistingIf (const std::initializer_list< NewAgentEventUid > &uids)
 
bool WillBeCopied (NewAgentEventUid event) const
 
bool WillBeRemoved (NewAgentEventUid event) const
 
void * operator new (size_t size)
 
void operator delete (void *p)
 

Private Member Functions

 BDM_BEHAVIOR_HEADER (Secretion, Behavior, 2)
 

Private Attributes

std::string substance_
 
DiffusionGriddgrid_ = nullptr
 
real_t quantity_ = 1
 

Detailed Description

Secrete substance at Agent position.

Definition at line 28 of file secretion.h.

Constructor & Destructor Documentation

◆ Secretion() [1/3]

bdm::Secretion::Secretion ( )
default

◆ Secretion() [2/3]

bdm::Secretion::Secretion ( const std::string &  substance,
real_t  quantity = 1 
)
inlineexplicit

Definition at line 33 of file secretion.h.

◆ Secretion() [3/3]

bdm::Secretion::Secretion ( DiffusionGrid dgrid,
real_t  quantity = 1 
)
inlineexplicit

Definition at line 39 of file secretion.h.

◆ ~Secretion()

virtual bdm::Secretion::~Secretion ( )
virtualdefault

Member Function Documentation

◆ BDM_BEHAVIOR_HEADER()

bdm::Secretion::BDM_BEHAVIOR_HEADER ( Secretion  ,
Behavior  ,
 
)
private

◆ Initialize()

void bdm::Secretion::Initialize ( const NewAgentEvent event)
inlineoverridevirtual

This method is called to initialize new behaviors that are created during a NewAgentEvent. Override this method to initialize attributes of your own Behavior subclasses. NB: Don't forget to call the implementation of the base class first. Base::Initialize(event); Failing to do so will result in errors.

Reimplemented from bdm::Behavior.

Definition at line 46 of file secretion.h.

◆ Run()

void bdm::Secretion::Run ( Agent agent)
inlineoverridevirtual

Implements bdm::Behavior.

Definition at line 54 of file secretion.h.

Member Data Documentation

◆ dgrid_

DiffusionGrid* bdm::Secretion::dgrid_ = nullptr
private

Definition at line 61 of file secretion.h.

◆ quantity_

real_t bdm::Secretion::quantity_ = 1
private

Definition at line 62 of file secretion.h.

◆ substance_

std::string bdm::Secretion::substance_
private

Definition at line 60 of file secretion.h.


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