Teledyne LeCroy SAS_SATA Protocol Suite Verification Script Engine Reference Manual - Manual (Page 65)

65
17.2 SetMarker()
This function sets a marker (bookmark) 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
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 (extensions: *.smt, *.samt). For regular traces, it is ignored.
If wrong parameters were specified (such as an index exceeding the maximum index for a
specified transaction level), the function will do nothing, and an error message will be 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);
}