ProfileRoutine object

The ProfileRoutine object provides information about the routines in the performance analysis model. It includes the time (in seconds) spent in the routine, any called routines, the number of times each routine was called, and the class to which the routine belongs. You use the ProfileRoutine object in conjunction with the Profiling and ProfileCall or ProfileLine objects.

The ProfileRoutine object has no events.

Properties

ProfileRoutine property

Datatype

Description

AbsoluteSelfTime

Decimal

The time (in seconds) spent in this routine. If the routine executed more than once, this is the total time spent in the routine.

AbsoluteTotalTime

Decimal

The time (in seconds) spent in this routine and in routines called from this routine. If the routine executed more than once, this is the total time spent in the routine and in called routines.

Class

ProfileClass

The class the routine is in. For embedded SQL activities, the value is Embedded SQL. For global and system functions, the value is an invalid object.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

HitCount

Long

The number of times this routine was called or the number of objects created or destroyed.

Kind

ProfileRoutineKind (enumerated)

The kind of routine node. Values are:

RoutineESQL!  -- Represents an embedded SQL statement.

RoutineEvent! -- Represents an event.

RoutineFunction! -- Represents a function.

RoutineGarbageCollection! -- Represents a garbage collection phase.

RoutineObjectCreation! -- Represents object creation.

RoutineObjectDestruction! -- Represents object destruction.

RoutineRoot! -- Represents the windowing system.

MaxSelfTime

Decimal

The longest time (in seconds) spent in the routine itself. If the routine executed only once, this is the same as AbsoluteSelfTime.

MaxTotalTime

Decimal

The longest time (in seconds) spent in the routine and in called routines. If the routine executed only once, this is the same as AbsoluteTotalTime.

MinSelfTime

Decimal

The shortest time (in seconds) spent in the routine itself. If the routine executed only once, this is the same as AbsoluteSelfTime.

MinTotalTime

Decimal

The shortest time (in seconds) spent in the routine and in called routines. If the routine executed only once, this is the same as AbsoluteTotalTime.

Name

String

The name of the routine including the argument datatypes and return value. For embedded SQL activities, the value is the name of the statement (for example, SELECT). For object creation or destruction, the value is Object Create or Object Destroy.

PercentSelfTime

Double

AbsoluteSelfTime as a percentage of the total time (in seconds) tracing was active.

PercentTotalTime

Double

AbsoluteTotalTime as a percentage of the total time (in seconds) tracing was active.


Functions

ProfileRoutine function

Datatype returned

Description

ClassName in PowerScript Reference

String

Returns the name assigned to the object

GetContextService in PowerScript Reference

Integer

Creates a reference to a context-specific instance of the specified service

GetParent in PowerScript Reference

PowerObject

Returns a reference to the name of the parent object

IncomingCallList in PowerScript Reference

ErrorReturn (enumerated)

Provides a list of the callers (defined as ProfileCall objects) of this routine

LineList in PowerScript Reference

ErrorReturn (enumerated)

Provides a list, in line order, of the lines (defined as ProfileLine objects) in the routine

OutgoingCallList in PowerScript Reference

ErrorReturn (enumerated)

Provides a list of the calls (defined as ProfileCall objects) to other routines from within this routine

TypeOf in PowerScript Reference

Object (enumerated)

Returns the type of the object