Class Documentation

Name:SystemMonitor
Version:1.0
ID:ID_SYSTEMMONITOR
Status:Unspecified
Category:Tool
Date:March 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2000-2001. All rights reserved.
Short:  Monitors the current status of the system.



Description

The SystemMonitor class is a basic monitoring tool for observing an Athene system in real time. It prints text-based information on system details such as the total amount of memory in use and the number of objects in the system. The class is simple in its construct but the level of functionality and printed information will be increased over time.

To use the class, you need to initialise it to a drawable object and set the coordinates to position it correctly. After initialisation the SystemMonitor object will update itself automatically until it is freed from the system.

Refer to the SystemMonitor application in the scripts:development/ directory for an example as to the typical use of this class.

Structure

The SystemMonitor object consists of the following public fields:

XCoord  The horizontal coordinate of the SystemMonitor graphic.
YCoord  The vertical coordinate of the SystemMonitor graphic.
Field:XCoord
Synonyms:X
Short:The horizontal coordinate of the SystemMonitor graphic.
Type:LONG
Status:Read/Write

The horizontal coordinate of the SystemMonitor graphic is determined by this field. It is dynamic, so writing to it while the object is on display will also cause a visual update.

 

Field:YCoord
Synonyms:Y
Short:The vertical coordinate of the SystemMonitor graphic.
Type:LONG
Status:Read/Write

The vertical coordinate of the SystemMonitor graphic is determined by this field. It is dynamic, so writing to it while the object is on display will also cause a visual update.