Teledyne LeCroy SierraFC Verification Script Engine Reference Manual - Manual (Page 49)

Verification Script Engine Reference Manual
44
21.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 ( possible values : _FRM, _SEQ )
index - the transaction index of the event to jump
segment - the segment index of the event to jump. If omitted current segment index will be
used.
Remarks:
If no parameters were specified other than 'marker_text ' the application will set marker to the
current event being processed by VSE. The 'segment' parameter is used only when verification script
is running over multi-segmented trace ( extension : *.mlt ). For regular traces it is ignored.
If wrong parameters were specified ( like index exceeding the maximal index for specified
transaction level ) – the function will do nothing and 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 );
}