Calling abort stops the execution of ABE and prints the error message message to the console (and shows the error). Note that abort does not interrupt execution of JavaScript code immediately. However, the ABE core engine cancels all further activities, when the abort method has been called.

      if (some_error_condition) {
                              fmengine.abort('This is really not expected!!');
                              return; // required; otherwise do_some_stuff() would be executed.
                          }
                          do_some_stuff();

add an agent definition (Javascript) and gives the agent the name name.

add an agent by specifying the name of an agent type and gives the agent the name name.

See also: AddAgentType:method

add an agent type (and not a specific agent!) by specifying the name of an agent type. The agent type will get the name name. Using an agent type (instead of single agents) allow the creation of multiple agents programmatically (e.g. small landowners). Properties of the generated agents can be refined using the newAgent() handler function of the agent.

adds a management program (STP) whose definition is provided by the Javascript object program. The name of the program is used internally.

See also: Activity

checks if a given stand_id is valid (i.e., part of the currently simulated area).

log writes a log message. Each message is prefixed with a code for identifying the current stand and the current year of the simulation. The format of the prefix is: 'S_standid_Y_year_:'.

  fmengine.log('log message for stand ' + stand.id);
                      // produces (in year 0 and for stand 7)
                      abe: "S7Y0:" log message for stand 7

runActivity executes an Activity for stand given by standId. This bypasses the normal scheduling (useful for debugging/testing). This function calls the main execution function of the activity.

runActivityEvaluate executes an Activity for stand given by standId. This bypasses the normal scheduling (useful for debugging/testing). 'runActivityEvaluate' invokes the evaluation code of scheduled activites (e.g., ActThinning, ActScheduled).

Runs a planting activity (without the context of stand treatment programmes). This is especially useful for setting up initial stand conditions. The planting defines the activity according to the syntax of the planting activity.

  // global 'onInit' function is called during startup
                      function onInit() {
                        // run a planting activity for the stand 235 (30cm spruce trees on 90% of the pixels)
                        fmengine.runPlanting( 235, { species: "piab", fraction: 0.9, height: 0.3 });
                      }

This function adds quicklinks that trigger Javascript functions to the user interface of iLand. Each name-value pair defines one function call (name) and its description (value).

  // call this anywhere (e.g. in the body of the main javascript)
                      Globals.setUIShortcuts( { 'Globals.reloadABE()': 'full reload of ABE', 'test()': 'my dearest test function' } );

returns a list of valid stand-ids within the model. See also: StandId:property

  for (var s of fmengine.standIds) {
                         fmengine.standId = s; // set s to the current stand
                         console.log('Stand ' + s + ': ' + stand.flag('wui')); // print value of the attribute wui for all stands
                      }

updates the definition of a STP, i.e. replace the STP stp_name with a new Javascript object program.

If the stp_name is not found, an error is thrown.

See also: Activity