Programmer Guide/Macro Library/CObjEx

• File: CLASSES.STX, linked to library STX.LIB
• Title: Base class for objects used in script applications
• Parent: CObj, Derived classes: XPlot, XGraph, XWave

The class CObjEx is an enhanced base class designed for objects which are used in STx scripts. Objects based on this class are deleted automatically before the script application is finished. By convention a class based on CObjEx implements the following simple instantiation method:

cobjExInstance := cobjExClassName constructionArguments

Constructor

The default constructor calls the CObj constructor and writes a construct-message in the console window. The function takes no arguments and returns always 0 (success). It must be called by derived classes.

Destructor

The default constructor stops and deletes the internal timer (&logTimerItem), calls the CObj constructor and writes a destruct-message in the console window. It must be called by derived classes.

Member functions

Cleanup (static), Log, LogExt, LogExit, LogTimer, ELog

Cleanup

static

CObjEx Cleanup

Result

none:

Description

Delete all instances of classes based on CObjEx. This function is called automatically by the script processor (BScript) before the script application exits.

Log

public

cobjex log text

text

The text to write to the log window.

Result

none

Description

Write the message class-instance: text to the script console.

LogExit

cobjex logError result; text

result

The result to assign after returning.

text

The text to write to the console window.

Result

The value of argument result

Description

Writes the message class-instance: text to the script console and exits from 2 macros (= return from caller) with the return value result.

LogExt

Write text to the CON log window with the option of overwriting the last line. This is useful for progress reports.

Usage:

inst LogExt mode ; text

Parameters:

mode

If 0, the text overwrites the last log window line. If 1, the text is appended to the last log window line.

text

The text to write to the log window.

LogTimer

Start or stop the internal BScript timer. The elapsed time is written to the CON log window.

Usage:

inst LogTimer cmd

Parameters:

cmd

One of the following:

ON|BEGIN - Start the timer. If the timer has already been started, then the elapsed time in seconds is returned. The elapsed time is also displayed in the CON window.

OFF|END - Stop the timer. The elapsed time is also displayed in the CON window.

ELog

cobjex ELog level ; result ; text

level

The number of macro levels to return (2 means: return from calling-macro).

result

The result to set on returning.

text

The text to write to the console window.

Result

The value of the argument result. Note: This value is returned to macro addressed by argument level.

Description

Writes the message class-instance: ERROR - text to the script console and exits from level macros with the return value result.