veeosInit

Initializes the loading of veeos

Syntax

  • veeosInit has no underlying function

    • Usage

    Place this object at the beginning of any program that uses the veeos library. Set "Run Every Time" to cause this object to execute each time your program is run.

    Location

    menu: veeos ==> Veeos Init

    Notes

    Since the veeosInit object is to be included in all VEE programs that use the veeos library, it is designed to be as small as possible and to have the absolute minimum hard-coded functionality. In essence it does nothing other than to find and import a library called bootstrapLib and then run a function from that library called init. It also only runs the very first time a program is run and then takes no action later, hence minimizing overhead.

    In searching for bootstrapLib itself, veeosInit searches the below locations in series and stopping as soon as the first is found. This order is chosen for standard precedence: the most specific definition takes precedence.

    1. Environment variable - if it exists, the variable MY_BOOTSTRAPLIB is used to identify the library file to load.
    2. Local directory - searched for bootstrapLib.vxe
    3. Home directory - searched for bootstrapLib.vxe
    4. VEE Install directory- searched for bootstrapLib.vxe
    Hence  Hence the default behavior is to use the bootstrapLib that comes with veeos, but any other alternative takes precedence.

    NOTE that due to this behavior, veeosInit can initiate any functionality that the end user desires. All one needs to do is to create their own library and point to it. the only requirement is that there is a function called init() in this library. The end result is that although veeosInit is part of veeos it can alternately be used for initiating the end user's customizations instead (or in addition).

    By default, veeosInit runs the very first time  that a program containing it executes. On subsequent runs veeosInit skips its internal functionality in order to minimize the time it takes to run. To override this behavior, the Run Every Time option can be selected. This causes veeosInit to execute all of its functionality at every program run. This can be useful when doing development work since it causes a fresh start of veeos configuration. Run Every Time is best left unchecked after development is done.

    Reference

    Dependencies

    bootstrapLib

    Supported On

    VEE 7.0+, all platforms

    See Also

    bootstrapLib

    © 2015-2025. All Rights Reserved. Stan Bischof (stan@worldbadminton.com). Last updated 13 February 2024 08:50.