Teledyne LeCroy SATracer 3G Verification Script Engine manual - Manual (Page 53)

LeCroy Corporation Verification Script Engine Reference Manual Version 1.01
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 - the text of the marker
level - the transaction level of the event to jump to (possible values: _LINK, _ATA)
index - the transaction index of the event to jump to
segment - the segment index of the event to jump to. If omitted, the current segment index will
be used.
Remarks:
If no parameters were specified, other than marker_text, the application will set 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 (like 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 );
}
48