TraceTree object

The TraceTree object is used to analyze the performance of a PowerBuilder application. It provides a tree model listing all the nodes logged in a given trace file. It includes the functions you call to name the trace file to be analyzed, build the tree model, and list the top-level entries in the tree model. You use the TraceTree object in conjunction with the TraceTreeNode, TraceTreeError, TraceTreeESQL, TraceTreeGarbageCollect, TraceTreeLine, TraceTreeObject, TraceTreeRoutine, and TraceTreeUser objects.

The TraceTree object has no events.

Properties

TraceTree property

Datatype

Description

ApplicationName

String

The name of the application used to generate the trace file.

ClassDefinition

PowerObject

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

CollectionTime

Decimal

The amount of time (in seconds) taken by the collection of trace data. This time has already been accounted for in the timestamps from the trace file (the proper amount of time has been subtracted from the timestamps before they are put in the trace file). The value is NULL if no model was built.

NumberOfActivities

Long

The total number of activities that exist in the trace file. The value is 0 if this is called before the trace file name is set.

TraceFileName

String

The name of the trace file to use to build the model. The value is an empty string if the name has not been successfully set.


Functions

TraceTree function

Datatype returned

Description

BuildModel

ErrorReturn

(enumerated)

Builds a tree model based on the previously specified trace file

ClassName

String

Returns the name assigned to the object

DestroyModel

ErrorReturn

(enumerated)

Destroys the current tree model

EntryList

ErrorReturn

(enumerated)

Provides a list of top-level entries (defined as TraceTreeNode objects) included in the model

GetContextService

Integer

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

GetParent

PowerObject

Returns a reference to the name of the parent object

SetTraceFileName

ErorReturn

Indicates the name of the trace file to use for analysis and creates the format of the file header

TypeOf

Object (enumerated)

Returns the type of the object