Libraries.System.SystemHelper Documentation

This class provides some basic system functions. What it returns is dependent on the implementation of the language.

Example Code

use Libraries.System.SystemHelper

SystemHelper help
output help:GetAvailableProcessors()

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetAvailableProcessors()This action returns the total number of processors available to the program.
GetFreeMemory()This action returns the amount of memory that is currently free on the system.
GetHashCode()This action gets the hash code for an object.
GetMaximumMemory()This action returns the maximum amount of memory available on the system.
GetTotalMemory()This action returns the total amount of memory currently on the system.
RequestGarbageCollection()This action asks the system to collect any garbage currently in memory.
Sleep(integer milliseconds)This class provides some basic system functions.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetAvailableProcessors()

This action returns the total number of processors available to the program.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        output help:GetAvailableProcessors()

Return

number: The number of processors currently available to this program.

GetFreeMemory()

This action returns the amount of memory that is currently free on the system. How this is computed is implementation dependent.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        output help:GetFreeMemory()

Return

number: The amount of free memory available.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetMaximumMemory()

This action returns the maximum amount of memory available on the system.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        output help:GetMaximumMemory()

Return

number: The maximum amount of memory available to the system.

GetTotalMemory()

This action returns the total amount of memory currently on the system.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        output help:GetTotalMemory()

Return

number: The total amount of memory allocated.

RequestGarbageCollection()

This action asks the system to collect any garbage currently in memory. Whether the system honors the request depends on the implementation.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        output help:RequestGarbageCollection()

Sleep(integer milliseconds)

This class provides some basic system functions. What it returns is dependent on the implementation of the language.

Example Code

use Libraries.System.SystemHelper

        SystemHelper help
        help:Sleep(1000) //one second

Parameters