In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-addCategory(-a)
|
string
|
|
|
Add a new category for the profiler.
Returns the index of the new category.
|
|
-allCategories(-ac)
|
|
|
|
Query the names of all categories.
If the categoryInfo flag is set then alternate the name of the category
with the description of the category.
|
|
-bufferSize(-b)
|
int
|
|
|
Toggled : change the buffer size to fit the specified number of events (requires that sampling is off)
Query : return the current buffer size
The new buffer size will only take effect when next sampling starts.
When the buffer is full, the recording stops.
|
|
-categoryIndex(-ci)
|
int
|
|
|
Used in conjunction with other flags, to indicate the index of the category.
In query mode, this flag needs a value.
|
|
-categoryIndexToName(-cin)
|
int
|
|
|
Returns the name of the category with a given index.
In query mode, this flag needs a value.
|
|
-categoryInfo(-cf)
|
string
|
|
|
When used with the addCategory flag set the description of the added profiler category.
In query mode return the description of the category referenced by either
the categoryIndex or categoryName flags.
In query mode, this flag can accept a value.
|
|
-categoryName(-cn)
|
string
|
|
|
Used in conjunction with other flags, to indicate the name of the category.
In query mode, this flag needs a value.
|
|
-categoryNameToIndex(-cni)
|
string
|
|
|
Returns the index of the category with a given name.
In query mode, this flag needs a value.
|
|
-categoryRecording(-cr)
|
boolean
|
|
|
Toggled : Enable/disable the recording of the category.
Query : return if the recording of the category is On.
Requires the -categoryIndex or -categoryName flag to specify the category to be queried.
|
|
-clearAllMelInstrumentation(-cam)
|
|
|
|
Clear all MEL command or procedure instrumentation.
|
|
-colorIndex(-coi)
|
int
|
|
|
Used with "-instrumentMel true" to specify the color index to show the
profiling result.
|
|
-eventCPUId(-eci)
|
|
|
|
Query the CPU ID of the event at the given index.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventCategory(-eca)
|
|
|
|
Query the category index the event at the given index belongs to.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventColor(-eco)
|
|
|
|
Query the color of the event at the given index.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventCount(-ec)
|
|
|
|
Query the number of events in the buffer
|
|
-eventDescription(-ed)
|
|
|
|
Query the description of the event at the given index.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventDuration(-edu)
|
|
|
|
Query the duration of the event at the given index, the time unit is microsecond.
Note that a signal event has a 0 duration.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventIndex(-ei)
|
int
|
|
|
Used usually in conjunction with other flags, to indicate the index of the event.
In query mode, this flag needs a value.
|
|
-eventName(-en)
|
|
|
|
Query the name of the event at the given index.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventStartTime(-et)
|
|
|
|
Query the time of the event at the given index, the time unit is microsecond.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-eventThreadId(-eti)
|
|
|
|
Query the thread ID of the event at the given index.
Requires the -eventIndex flag to specify the event to be queried.
|
|
-instrumentMel(-in)
|
boolean
|
|
|
Enable/Diable the instrumentation of a MEL command or procedure.
When the instrumentation is enabled, the execution of MEL command
or procedure can be profiled and shown in the Profiler window.
To enable the instrumentation requires the -procedureName, -colorIndex
and -categoryIndex flags.
To disable the instrumentation requires the -procedureName flag.
|
|
-load(-l)
|
string
|
|
|
Read the recorded events from the specified file
|
|
-output(-o)
|
string
|
|
|
Output the recorded events to the specified file
|
|
-procedureDescription(-pd)
|
string
|
|
|
Used with "-instrumentMel true" to provide a description of the MEL
command or procedure being instrumented.
This description can be viewed in the Profiler Tool window.
|
|
-procedureName(-pn)
|
string
|
|
|
Used with -instrumentMel to specify the name of the procedure to be
enabled/disabled the instrumentation.
|
|
-removeCategory(-rc)
|
string
|
|
|
Remove an existing category for the profiler.
Returns the index of the removed category.
|
|
-reset(-r)
|
|
|
|
reset the profiler's data (requires that sampling is off)
|
|
-sampling(-s)
|
boolean
|
|
|
Toggled : Enable/disable the recording of events
Query : return if the recording of events is On.
|
|
-signalEvent(-sig)
|
|
|
|
Query if the event at the given index is a signal event.
Requires the -eventIndex flag to specify the event to be queried.
A Signal Event only remembers the start moment and has no knowledge about
duration. It can be used in cases when the user does not care about the
duration but only cares if this event does happen.
|
|
-signalMelEvent(-sim)
|
boolean
|
|
|
Used with "-instrumentMel true", inform profiler that this instrumented
MEL command or procedure will be taken as a signal event during profiling.
A Signal Event only remembers the start moment and has no knowledge about
duration. It can be used in cases when the user does not care about the
duration but only cares if this event does happen.
|
|