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

Verification Script Engine Reference Manual
5
3 Interaction between SierraFC Protocol Suite and
verification script
When a user runs a script over a recorded trace, the following sequence occurs:
1. Prior to sending information to the script's main processing function ProcessEvent(), VSE looks
for the function OnStartScript() and calls it if it is found. In this function, some setup routines
can be made such as specifying what kind of trace events should be passed to the script, and
setting up initial values of global script-specific global variables.
2. Next, the VSE goes through the recorded trace and checks if the current frame suits specified
sending criteria – if it does, VSE calls the script main processing function ProcessEvent() and
sends some information about the current event to the script input context variables.
(Please refer to the topic “Input context variables” below in this document for full description of
verification script input context variables )
3. ProcessEvent() – is the main verification routine in which all processing of incoming trace
event is done. This function must be present in all verification scripts. When the verification
program consists of a few stages, the ProcessEvent() function processes the event sent to the
script, verifies that information contained in the event is appropriate for the current stage and
decides if VSE should continue script running or if the whole result is clear on the current stage
– tell VSE to complete execution of the script.
The completion of the test before the entire trace has been evaluated is usually done
by setting output context variable : out.Result = _VERIFICATION_PASSED or
_VERIFICATION_FAILED.
(Please refer to the topic “Output context variables” below in this document for full description
of verification script output context variables)
NOTE: Not only does a verification script evaluate recorded traces by some criteria - but
it can also extract information of interest and post-process it later by some third-party
applications( There is a set of script functions allowing to save extracted data in text
files or send it to other applications via COM/Automation interfaces )
4. When script running has completed, VSE looks for function : OnFinishScript() and calls it if it is
found. In this function some resetting procedures can be done.
The following figure illustrates the interaction between SierraFC Protocol Suite application and running
verification script: