Teledyne LeCroy UWBTracer Verification Script Engine Manual - Manual (Page 81)

LeCroy Corporation Verification Script Engine Manual, version 2.2
20 COM/Automation Communication Functions
This group of functions covers VSE capabilities to communicate with COM/Automation™ clients connected to
the UWBTracer™ application. (See the UWBTracer Automation Manual for details about how to connect to the
UWBTracer application and VSE)
20.1 NotifyClient()
This function sends information to COM/Automation™ client applications in custom format. The client
application receives a VARIANT object, which it is supposed to parse.
Format:
NotifyClient(event_id, param_list)
Parameters:
event_id Integer parameter representing event identifier
param_list List of parameters to be sent to the client application.
Each parameter might be an integer, string, raw data (byte chain), or list.
(See the LeCroy Protocol Analyzers File-Based Decoding User Manual for details about
data types available in CSL.). Because the list itself may contain integers, strings, raw
data, or other lists, it is possible to send very complicated messages. (Lists should be
treated as arrays of VARIANTs.)
Example:
…
if(SomeCondition())
{
NotifyClient(2, [ in.Index, "RF CHANNEL", “Beacon Frame", in.SubType,
in. PayloadLength, TimeToText(in.Time)]);
}
…
# Send 2 parameters to client applications:
# 2 (integer),
# [ in.Index, "RF CHANNEL", “Beacon Frame", in.SubType,
# in. PayloadLength, TimeToText(in.Time)] (list)
Remark:
See an example of handling this notification by client applications and parsing code in the
UWBTracer Automation™ Manual.
Page 81 of 95