The iLand Javascript API The iLand Javascript API

  • API Docs for Version: 1.0

    • APIs

    Show:

    Stand Class

    Defined in: ABE\abe_stand.js:1
    Module: ABE

    Access to properties of the current stand. The stand variable is available in the execution context of forest management and provides access to properties and functions of the stand that is currently processed.

    Note that the variable stand is provided through the C++ framework and does not need to be created separately.

    Use the 'flag' and 'setFlag' methods to (persistently) modify / read user-specific properties for each stand. This is a means to pass stand-specific information between activities (or between different events within one activity).

    Methods

    activityByName

    (
    • activity_name
    )
    Activity

    Defined in ABE\abe_stand.js:242

    Use activityByName to retrieve an Activity object.

      stand.activity("my_thinning_2").enabled = false; // disable an activity
                      var act = stand.activity("my_thinning_1"); // save a reference to the activity for later use

    See also: the variable activity

    Parameters:

    • activity_name String

      The name of the activity to be retrieved. Activity names are provided during activity definition (see fmengine.addManagement)

    Returns:

    Activity:

    the Activity, or undefined if not found.

    flag

    (
    • name
    )

    Defined in ABE\abe_stand.js:256

    Retrieves the stand-specific property associated with the name 'name' for the stand of the current execution context.

      stand.setFlag('test', 3); // simple values
                      stand.setFlag('my_goal', { s1: 10, s2: 20, s3: function(){return this.s1+this.s2;} } ); // complex objects (including functions are allowed)
                    
                      fmengine.log( stand.flag('my_goal').s3 + stand.flag('test') + stand.U  ); // -> 133 (if U=100 of the stand)

    Parameters:

    • name String

      The (user-defined) property name of the stored parameter.

    reload

    ()

    Defined in ABE\abe_stand.js:214

    Force a reload of the stand data, i.e. fetch stand statistics (e.g. basal area, age) from the trees comprising the stand.

    Usually, this is done automatically by ABE, however, it might be useful in some rare circumstances.

    relSpeciesBasalArea

    (
    • index
    )

    Defined in ABE\abe_stand.js:204

    Retrieve the basal area share (0..1) of the species at position index.

    // get the share of the dominant species:
                    log( stand.relSpeciesBasalArea(0) * 100 + "%");

    Parameters:

    • index Integer

      The index of the species (valid between 0 and nspecies-1).

    relSpeciesBasalAreaOf

    (
    • speciescode
    )

    Defined in ABE\abe_stand.js:197

    Retrieve the relative basal area of the species 'speciescode'.

    Parameters:

    • speciescode String

      The code of the species (e.g., 'piab').

    setFlag

    (
    • name
    • value
    )

    Defined in ABE\abe_stand.js:268

    Sets 'value' as the stand-specific property associated with the name 'name' for the stand of the current execution context.

    Parameters:

    • name String

      The (user-defined) property name of the stored parameter.

    • value Value

      The value that should be stored for 'name'. 'value' can be any valid Javascript expression (including objects).

    setSTP

    (
    • stp_name
    )

    Defined in ABE\abe_stand.js:159

    Sets a new STP for a stand. This can be used to "switch" from one STP to another STP. Use updateSTP() from fmengine to change/update an already existing STP.

    See also updateManagement.

    // get the share of the dominant species:
                    console.log(stand.stp.name); // e.g. 'BAU'
                    fmengine.addManagement( { ... }, 'femel');
                    fmengine.standId=1; // explicitly set to stand with ID = 1
                    stand.setSTP('femel');

    Parameters:

    • stp_name String

      The name of the STP to set for the stand

    sleep

    (
    • years
    )

    Defined in ABE\abe_stand.js:224

    The ´sleep´ method suspends the activities on the stand for years years. Only after the specified has elapsed, ABE continues to examine the stand.

    Parameters:

    • years Integer

      The number of years that the stand should sleep.

    speciesBasalArea

    (
    • index
    )

    Defined in ABE\abe_stand.js:182

    Retrieve the basal area of the species at position index.

    Parameters:

    • index Integer

      The index of the species (valid between 0 and nspecies-1).

    speciesBasalAreaOf

    (
    • speciescode
    )

    Defined in ABE\abe_stand.js:189

    Retrieve the basal area of the species with the species code 'speciescode'. Note that only trees with height > 4m are included.

    Parameters:

    • speciescode String

      The code of the species (e.g., 'piab').

    speciesId

    (
    • index
    )

    Defined in ABE\abe_stand.js:175

    Retrieve the species id at position index.

    Parameters:

    • index Integer

      The index of the species (valid between 0 and nspecies-1).

    wakeup

    ()

    Defined in ABE\abe_stand.js:233

    The ´wakeup´ method wakes up a stand again that was set to sleep earlier. The sleeping phase in canceled, and the stand is re-evaluated in the next year.

    Properties

    absoluteAge

    Double

    Defined in ABE\abe_stand.js:128

    The age of the stand given in years since the rotation started. At startup, the absoluteAge is estimated from the age of the stand (i.e. the mean age of the initialized trees). Later, the stand age counter is reset by management activities. Note that this property is writable.

    See also age.

    activity

    Activity

    Defined in ABE\abe_stand.js:49

    The Activity object linked to the current stand.

    See also: Activity

    Default: undefined

    age

    Double

    Defined in ABE\abe_stand.js:118

    The mean age of the stand (years). It is calculated as basal area weighted mean age of all trees on the stand (>4m). Note the difference to absoluteAge, which is the number of years since the rotation started.

    See also absoluteAge.

    area

    Double

    Defined in ABE\abe_stand.js:151

    The total area of the stand in hectares.

    basalArea

    Double

    Defined in ABE\abe_stand.js:79

    The basal area / ha stocking on the stand (living trees, >4m).

    dbh

    Double

    Defined in ABE\abe_stand.js:94

    The mean DBH in cm. It is calculated as basal area weighted mean DBH of all trees on the stand (>4m). See also basalArea.

    elapsed

    Int

    Defined in ABE\abe_stand.js:277

    The number of years since the execution of the last activity for the current stand. Value is -1 if no activity was executed previously.

    height

    Double

    Defined in ABE\abe_stand.js:102

    The mean height of the stand (meter). It is calculated as basal area weighted mean height of all trees on the stand (>4m). See also topHeight.

    id

    Integer

    Defined in ABE\abe_stand.js:31

    The id of the stand that is currently processed.

    See also: standId in fmengine.

    Default: -1

    lastActivity

    String

    Defined in ABE\abe_stand.js:284

    The name of the last previously executed activity, or an empty string if no activity was executed before. The name can be used to access properties of the activity.

         if (stand.lastActivity == "thinning1")
                              stand.activity( stand.lastActivity ).enabled = true; // re-enable last activity if it was 'thinning1'

    nspecies

    Int

    Defined in ABE\abe_stand.js:139

    The number of different tree species present on the stand (trees >4m). Use to iterate over the available species on the stand:

      // print the species id and the basal area for each available species.
                      // note that the species are ordered by the basal area share.
                      for (var i=0;i<stand.nspecies;++i)
                          log(stand.speciesId(i) + ": " + stand.speciesBasalArea(i));

    stp

    STP

    Defined in ABE\abe_stand.js:59

    The STP object linked to the current stand, i.e. the stand treatment program currently active for the stand.

    See also: STP, setSTP

    Default: undefined

    topHeight

    Double

    Defined in ABE\abe_stand.js:110

    The top height (in meters) is defined as the mean height of the 100 thickest trees per ha. For larger/ smaller stands, the number of trees is scaled accordingly. See also height.

    trace

    Boolean

    Defined in ABE\abe_stand.js:15

    If trace is set to true, detailed log information is produced by ABE. This is useful for testing/ debugging. The trace-mode can be switched on/ off like this:

      // enable trace for stand 7
                      fmengine.standId = 7; // set the current stand to the stand with Id 7
                      stand.trace = true; // enable trace

    See also: verbose

    Default: false

    trees

    TreeList

    Defined in ABE\abe_stand.js:68

    The TreeList object (i.e., the list of trees on the stand), linked to the current stand.

    See also: TreeList

    Default: undefined

    U

    Double

    Defined in ABE\abe_stand.js:296

    The rotation length of the current stand. The rotation length is defined by the stand treatment programme that is currently assigned to a given stand. The 'U' is frequently used for timing activites relative to the length of the period.

    unit

    Unit

    Defined in ABE\abe_stand.js:41

    The Unit object linked to the current stand.

    Default: undefined

    volume

    Double

    Defined in ABE\abe_stand.js:87

    The total standing timber volume / ha of the stand (living trees, >4m).