Teledyne LeCroy Verification Script Engine for Teledyne LeCroy PETracer Reference Manual - Manual (Page 69)

Teledyne LeCroy Verification Script Engine Reference Manual Version 6.6x
64
16.2 SetMarker()
This function sets a marker for some trace event.
Format:
SetMarker( marker_text )
SetMarker( marker_text, level, index, segment )
Parameters:
marker_text Text of the marker
level Transaction level of the event to jump to (possible values: _PACKET, _LINK, _SPLIT)
index Transaction index of the event to jump to
segment Segment index of the event to jump to.
If omitted, the current segment index is used.
Remarks:
If no parameters were specified, other than marker_text, the application sets a marker to the current
event being processed by VSE. The segment parameter is used only when a verification script is running over a
multi-segmented trace (extension: *.pem). For regular traces it is ignored.
If wrong parameters were specified (like an index exceeding the maximum index for a specified
transaction level), the function does nothing and an error message is sent to the output window.
Example:
…
# set marker to the current event
if( Something == interesting ) SetMarker( "!!! Something cool !!!" );
…
if( SomeCondition )
{
interesting_segment = GetEventSegNumber();
interesting_level = in.Level;
interesting_index = in.Index;
}
…
OnFinishScript()
{
…
# set marker to the interesting event…
SetMarker( " !!! Cool Marker !!! ", interesting_level,
interesting_index,
interesting_segment );
# go to the interesting event…
GotoEvent( interesting_level, interesting_index, interesting_segment );
}