iLand
Public Member Functions | Protected Member Functions | List of all members
BITE::BiteLifeCycle Class Reference

#include <bitelifecycle.h>

Inheritance diagram for BITE::BiteLifeCycle:
BITE::BiteItem

Public Member Functions

Q_INVOKABLE BiteLifeCycle (QJSValue obj)
 
void setup (BiteAgent *parent_agent)
 
QString info ()
 
void notify (BiteCell *cell, BiteCell::ENotification what)
 
void run ()
 
bool dieAfterDispersal () const
 
int numberAnnualCycles (BiteCell *cell)
 fetch the number of cycles the agent should run for the cell More...
 
bool shouldSpread (BiteCell *cell)
 should the cell be an active spreader in the next iteration? More...
 
int outbreakYears ()
 number of years that an outbreak wave is currently active the value is 0 for non-outbreak years More...
 
- Public Member Functions inherited from BITE::BiteItem
 BiteItem (QObject *parent=nullptr)
 
Q_INVOKABLE BiteItem (QJSValue obj)
 
BiteAgentagent () const
 
bool runCells () const
 true if the item runs cell by cell More...
 
QString name () const
 
void setName (QString name)
 
QString description () const
 

Protected Member Functions

QStringList allowedProperties ()
 
- Protected Member Functions inherited from BITE::BiteItem
int cellSize () const
 
void checkProperties (QJSValue obj)
 
QJSValue thisJSObj ()
 
void setRunCells (bool rc)
 
bool verbose ()
 

Additional Inherited Members

- Public Slots inherited from BITE::BiteItem
virtual void afterSetup ()
 called once after the full agent is set up More...
 
virtual void beforeRun ()
 for initializations, called every year More...
 
virtual void runCell (BiteCell *cell, ABE::FMTreeList *treelist, ABE::FMSaplingList *saplist)
 
- Protected Attributes inherited from BITE::BiteItem
QJSValue mObj
 the JS value used to setup the item More...
 
QJSValue mThis
 the JS representation of the item More...
 
- Properties inherited from BITE::BiteItem
QString name
 
BiteAgentagent
 

Constructor & Destructor Documentation

◆ BiteLifeCycle()

BITE::BiteLifeCycle::BiteLifeCycle ( QJSValue  obj)

Member Function Documentation

◆ allowedProperties()

QStringList BITE::BiteLifeCycle::allowedProperties ( )
protectedvirtual

Reimplemented from BITE::BiteItem.

◆ dieAfterDispersal()

bool BITE::BiteLifeCycle::dieAfterDispersal ( ) const
inline

◆ info()

QString BITE::BiteLifeCycle::info ( )
virtual

Reimplemented from BITE::BiteItem.

◆ notify()

void BITE::BiteLifeCycle::notify ( BiteCell cell,
BiteCell::ENotification  what 
)
virtual

Reimplemented from BITE::BiteItem.

◆ numberAnnualCycles()

int BITE::BiteLifeCycle::numberAnnualCycles ( BiteCell cell)

fetch the number of cycles the agent should run for the cell

◆ outbreakYears()

int BITE::BiteLifeCycle::outbreakYears ( )
inline

number of years that an outbreak wave is currently active the value is 0 for non-outbreak years

◆ run()

void BITE::BiteLifeCycle::run ( )
virtual

Reimplemented from BITE::BiteItem.

◆ setup()

void BITE::BiteLifeCycle::setup ( BiteAgent parent_agent)
virtual

Reimplemented from BITE::BiteItem.

◆ shouldSpread()

bool BITE::BiteLifeCycle::shouldSpread ( BiteCell cell)

should the cell be an active spreader in the next iteration?


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