iLand
Public Slots | Public Member Functions | List of all members
WindScript Class Reference

#include <windscript.h>

Inheritance diagram for WindScript:

Public Slots

int windEvent (double windspeed, double winddirection, int max_iteration, bool simulate=false, int iteration=-1)
 trigger a wind event from javascript. More...
 
bool gridToFile (QString grid_type, QString file_name)
 create a "ESRI-grid" text file 'grid_type' is one of a fixed list of names, 'file_name' the ouptut file location More...
 
QJSValue grid (QString type)
 returns a ScriptGrid with the requested type More...
 
void initialize ()
 initialize/ reset the wind module More...
 
void initializeEdgeAge (int years)
 initialize/reset the age of edges More...
 
int damagedArea (int threshold, QString fileName)
 number of damaged pixels with a patchsize>'threshold'; save to grid to "fileName" (if not empty) More...
 

Public Member Functions

 WindScript (QObject *parent=0)
 
void setModule (WindModule *module)
 

Constructor & Destructor Documentation

◆ WindScript()

WindScript::WindScript ( QObject *  parent = 0)
explicit

Member Function Documentation

◆ damagedArea

int WindScript::damagedArea ( int  threshold,
QString  fileName 
)
slot

number of damaged pixels with a patchsize>'threshold'; save to grid to "fileName" (if not empty)

◆ grid

QJSValue WindScript::grid ( QString  type)
slot

returns a ScriptGrid with the requested type

◆ gridToFile

bool WindScript::gridToFile ( QString  grid_type,
QString  file_name 
)
slot

create a "ESRI-grid" text file 'grid_type' is one of a fixed list of names, 'file_name' the ouptut file location

◆ initialize

void WindScript::initialize ( )
slot

initialize/ reset the wind module

◆ initializeEdgeAge

void WindScript::initializeEdgeAge ( int  years)
slot

initialize/reset the age of edges

◆ setModule()

void WindScript::setModule ( WindModule module)
inline

◆ windEvent

int WindScript::windEvent ( double  windspeed,
double  winddirection,
int  max_iteration,
bool  simulate = false,
int  iteration = -1 
)
slot

trigger a wind event from javascript.

Parameters
windspeedaverage wind speed (m/s)
winddirecitonwind direction (0=N..180=S..270=W)
maximum_iterationsmaximum number of iterations
simulateif true, trees are not really affected
iterationif given a value >=0, then only one iteration is calculated ("interactive mode")

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