iLand
Public Member Functions | Static Public Member Functions | Friends | List of all members
BITE::BiteEngine Class Reference

#include <biteengine.h>

Public Member Functions

 ~BiteEngine ()
 
void setup ()
 
void addAgent (BiteAgent *new_agent)
 
BiteAgentagentByName (QString name)
 get agent by name More...
 
QStringList agentNames ()
 
QJSEngine * scriptEngine ()
 
int currentYear () const
 
void setYear (int year)
 
Grid< double > * preparePaintGrid (QObject *handler, QString name)
 
QStringList evaluateClick (QObject *handler, const QPointF coord, const QString &grid_name)
 
double variableValueAt (QObject *handler, const QPointF coord, const int layer_id)
 
void run ()
 
void error (QString error_msg)
 called from agents/items if an error occured during script execution More...
 
QMutex * serializeJS ()
 safe guard calls to the JS engine (only 1 thread allowed) More...
 
void notifyTreeRemoval (Tree *tree, int reason)
 called by iLand for every tree that is removed/harvested/died due to disturbance. More...
 
void addTreeRemovalFunction (int reason, BiteAgent *agent)
 

Static Public Member Functions

static BiteEngineinstance ()
 get singleton of the BiteEngine More...
 
static QJSValue valueFromJs (const QJSValue &js_value, const QString &key, const QString default_value=QLatin1Literal(""), const QString &errorMessage=QLatin1Literal(""))
 

Friends

class BiteOutput
 

Constructor & Destructor Documentation

◆ ~BiteEngine()

BITE::BiteEngine::~BiteEngine ( )

Member Function Documentation

◆ addAgent()

void BITE::BiteEngine::addAgent ( BiteAgent new_agent)

◆ addTreeRemovalFunction()

void BITE::BiteEngine::addTreeRemovalFunction ( int  reason,
BiteAgent agent 
)
inline

◆ agentByName()

BiteAgent * BITE::BiteEngine::agentByName ( QString  name)

get agent by name

◆ agentNames()

QStringList BITE::BiteEngine::agentNames ( )

◆ currentYear()

int BITE::BiteEngine::currentYear ( ) const
inline

◆ error()

void BITE::BiteEngine::error ( QString  error_msg)

called from agents/items if an error occured during script execution

◆ evaluateClick()

QStringList BITE::BiteEngine::evaluateClick ( QObject *  handler,
const QPointF  coord,
const QString &  grid_name 
)

◆ instance()

static BiteEngine * BITE::BiteEngine::instance ( )
inlinestatic

get singleton of the BiteEngine

◆ notifyTreeRemoval()

void BITE::BiteEngine::notifyTreeRemoval ( Tree tree,
int  reason 
)

called by iLand for every tree that is removed/harvested/died due to disturbance.

◆ preparePaintGrid()

Grid< double > * BITE::BiteEngine::preparePaintGrid ( QObject *  handler,
QString  name 
)

◆ run()

void BITE::BiteEngine::run ( )

◆ scriptEngine()

QJSEngine * BITE::BiteEngine::scriptEngine ( )

◆ serializeJS()

QMutex * BITE::BiteEngine::serializeJS ( )
inline

safe guard calls to the JS engine (only 1 thread allowed)

◆ setup()

void BITE::BiteEngine::setup ( )

◆ setYear()

void BITE::BiteEngine::setYear ( int  year)
inline

◆ valueFromJs()

QJSValue BITE::BiteEngine::valueFromJs ( const QJSValue &  js_value,
const QString &  key,
const QString  default_value = QLatin1Literal(""),
const QString &  errorMessage = QLatin1Literal("") 
)
static

◆ variableValueAt()

double BITE::BiteEngine::variableValueAt ( QObject *  handler,
const QPointF  coord,
const int  layer_id 
)

Friends And Related Function Documentation

◆ BiteOutput

friend class BiteOutput
friend

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