beautypg.com

Module data, Moduletype, Outputtype – Teledyne LeCroy FireInspector - File Based Decoding User Manual

Page 72: Inputtype, Levelname, Decoderdesc

background image

66

CATC S

CRIPTING

L

ANGUAGE

1.0

C

HAPTER

15

Reference Manual

Modules

Module Data

There are several standard global variables that should be defined in a module
which are queried by the application to figure out what the module is supposed to
do.

ModuleType

Required. A string describing the role of the script. Currently, only

Transaction Decoder

and

DataBlock Decoder

are valid.

Example

set ModuleType = "Transaction Decoder";

Transaction Decoder

uses

ProcessData()

.

DataBlock Decoder

does not.

OutputType

Required. A string label describing the output of the script. Example :

AVC

Transaction

Example

set OutputType = "AV/C Transaction";

InputType

Required. A string label describing the input to the script. Input and output types
should be matched by the application in order to decide which modules to invoke
on which contexts.

Example

set InputType = "1394 Transaction";

LevelName

Optional. A string that names this decoder.

Example

set LevelName = "AV/C Test Transactions";

DecoderDesc

Optional. A string that describes this decoder. Displays as a toolbar icon tool tip.

Example

set DecoderDesc = "View test transactions";