beautypg.com

Chapter 13: decoder primitives, Abort(), Addcell() – Teledyne LeCroy FireInspector - File Based Decoding User Manual

Page 51: 13 decoder primitives, Abort() addcell(), Hapter, Ecoder, Rimitives

background image

45

CATC S

CRIPTING

L

ANGUAGE

1.0

C

HAPTER

13

Reference Manual

Decoder Primitives

C

HAPTER

13: D

ECODER

P

RIMITIVES

Abort()

Abort()

Return value

An integer that should be passed back to the application unchanged.

Comments

Called when an input context renders the currently pending transaction done, but is
not itself a member of that transaction. An example would be an input transaction
that represents some sort of reset condition that renders all pending transactions
invalid. The input transaction is not consumed by this action and will go on to be
considered for other pending transactions.

Example

if ( IsReset )
return Abort();

AddCell()

AddCell(string>, string>, string or null>, integer or list>,
any>)

Parameter

Meaning

Default Value

Comments

N/A

Parameter

Meaning

Default Value

Comments

name string

Displays in the name field of the cell.

value string

Displays in the value field of the cell.

description string or null

Displays in tool tip.

color integer or list

If not speci-

fied, a default

color is used

Color can be specified as either a packed color
value in an integer, or as an array of RGB values
ranging from 0-255. Displays in the name field
of the cell.