LineByLine Class Reference

Line-by-line Monitor. More...

Inheritance diagram for LineByLine:

Collaboration diagram for LineByLine:

Static Public Member Functions
_.Library.Status	AddRoutine (_.Library.List Routine, _.Library.Boolean Clear)
	Add a list of routines to be monitored. More...
_.Library.Status	Clear ()
	Clear collected results. More...
_.Library.String	GetMetrics (_.Library.Integer Select)
	Returns a list of metric names (delimited by ","). More...
_.Library.Integer	GetRoutineCount ()
	Get a count of the routines being monitored.
_.Library.String	GetRoutineName (_.Library.Integer Number)
	Used to fetch the names of routines being monitored. More...
_.Library.Boolean	IsActive (_.Library.String Routine)
	Tests whether a routine is currently being monitored and returns. More...
_.Library.Status	Pause ()
	Pause the collection. More...
_.Library.Status	Resume ()
	Resume collection. More...
_.Library.Status	Start (_.Library.List Routine, _.Library.List Metric, _.Library.List Process)
	Start a line-by-line monitor collection. More...
_.Library.Status	Stop ()
	Stop the line-by-line monitor collection.

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Line-by-line Monitor.

A facility to allow monitoring of ObjectScript routines on a line-by-line basis. The user may select which routines to monitor and any of the standard performance metrics supported by the PERFMON utility, as well as "Time" (clock time spent in line) and "TotalTime" (total clock time including in-line calls to other subroutines). See the GetMetrics() method for a list of metric names.

WARNING ! Starting the line-by-line monitor will enable the collection of statistics for every line of code executed by the selected routines and processes. This can have a major impact on the performance of a system, and it is recommended that you do this only on a 'test' system.

Member Function Documentation

AddRoutine()

_.Library.Status AddRoutine ( _.Library.List  Routine, _.Library.Boolean  Clear  )

static

Add a list of routines to be monitored.

Normally, a list of routines can be specified simply as a parameter of the Start() method. But if the user requires a list of routines which exceeds the maximum string length, then this method may be called repeatedly with routine lists, prior to calling Start().

The first time it is called, the user should make sure they specify the "Clear" parameter to initialize the list and ensure that any previous entries are cleared. Then when Start() is invoked, the "Routine" parameter should be null (Routine = ""). Routines may use the asterisk wildcard as in Start().

Clear()

_.Library.Status Clear ( )

static

Clear collected results.

Collection continues and results start to accumulate again.

GetMetrics()

_.Library.String GetMetrics ( _.Library.Integer  Select )

static

Returns a list of metric names (delimited by ",").

The "Select" parameter is used to select either a list of metrics which are currently being monitored (default of Select=1) or a list of all available metric names (Select=2).

If Select=3, this method will print a list of all available metrics and a short description to the current device.

GetRoutineName()

_.Library.String GetRoutineName ( _.Library.Integer  Number )

static

Used to fetch the names of routines being monitored.

The internal

list of routines is numbered from 1 to 'n', with 'n' being the count returned by the GetRoutineCount() method.

IsActive()

_.Library.Boolean IsActive ( _.Library.String  Routine )

static

Tests whether a routine is currently being monitored and returns.

TRUE or FALSE.

Pause()

_.Library.Status Pause ( )

static

Pause the collection.

Current results will still be available.

Resume()

_.Library.Status Resume ( )

static

Resume collection.

Results continue to accumulate.

Start()

_.Library.Status Start ( _.Library.List  Routine, _.Library.List  Metric, _.Library.List  Process  )

static

Start a line-by-line monitor collection.

Parameters are lists of

Routines, Metric names, and Process IDs to be monitored.

Routines may be "wildcarded" by using an asterisk as the final character of any routine name. A null list indicates AddRoutine has been used.

A null list of Metrics will use the default of "RtnLine, Time, TotalTime".

A null list of Process IDs will enable all processes.