The iLand Javascript API The iLand Javascript API

  • API Docs for Version: 2.0

    • APIs

    Show:

    Activity Class

    Defined in: ABE\abe_context_doc.js:275
    Module: ABE

    Access to properties of the current activity is provided by the activity property of a stand, and using the this property within event handlers.

    The variable provides access to properties and functions of the current activity (linked to a stand) that is currently processed. In addition, other activities of the (currently active) programme can be accessed with Stand/activity:method.

    Note that in previous versions a global variable activity was provided by the C++ framework. This is no longer the case for consistency reasons. Please use the stand.activity or this variables instead.

    See also: Variables stand (Stand)

       // within an activity:
   onEnter: function() {
      console.log( this.name ); // access the activity with this
   },
   onExecute: function() {
       fmengine.log('now running: ' + stand.activity.name); // access via the stand object
   }

    Item Index

    Properties

    Properties

    active

    Boolean

    Defined in ABE\abe_context_doc.js:304

    The active property indicates whether an activity can still be executed during this rotation. After an activity is executed, the active flag is set to false, and the next active (and enabled) activity is selected. At the end of a rotation, the active flag of all activities of the programme are set back to true. By changing the value of active, activities can be either removed from the current rotation, or re-enabled.

      //re-enable the 'todo' activity.
                      stand.activity("todo").active = true;

    See also: enabled

    Default: false

    enabled

    Boolean

    Defined in ABE\abe_context_doc.js:323

    An activity can only be executed, if the enabled property is true. Activities can be switched on/ off using this flag.

    Note that an activity needs also to be active in order to get executed.

      // switch off a repeating activity, when a height threshold is surpassed.
                      if (stand.hmean>12)
                          stand.activity('repeater').enabled = false;

    See also: active

    Default: false

    finalHarvest

    Boolean

    Defined in ABE\abe_context_doc.js:352

    An activity with finalHarvest=true ends a rotation when (successfully) executed. This resets the age counter and sets all activites active.

    Default: depends on activity type.

    name

    String

    Defined in ABE\abe_context_doc.js:375

    The name of the activity as provided in the definition of the activity.

    See also: fmengine.addManagement

    obj

    Javascript object

    Defined in ABE\abe_context_doc.js:362

    The obj is a general purpose javascript entity that is stored for an activity.

    Note that obj can hold arbitrary Javascript objects, including data structures and functions.

    See also: obj.

    Default: undefined

    scheduled

    Boolean

    Defined in ABE\abe_context_doc.js:341

    This flag indicates whether the Scheduler is used when this activity is run, i.e. if the exact date of execution is selected by the scheduling algorithm of ABE. The default value depends on the type of the activity, e.g., default is false for activities of type general, but true for scheduled activities.

    Default: depends on activity type.