User Manual

58
CATC SCRIPTING LANGUAGE 1.0 CHAPTER 14
Reference Manual FireInspector-Specific Primitives
In the example, “Identifier” is the value of bitfield_identifier and
“Label” is the value of bitfield_label.
For a complete description of GetNBits, see “GetNBits()” on page 41.
Example
See “Example for FireInspector-Specific Primitives” on page 60.
NextNBits -- Additional parameters
NextNBits contains an additional, optional argument in FireInspector to add data
to the BitfieldInit data structure: bitfield_label. In FireInspector,
NextNBits has this structure:
NextNBits(<bit_count integer>, <bitfield_label
string>
opt
)
Use bitfield_label to assign a label to the bits being read, and put them in the
bitfield referred to by the previous call to GetNBits. For example:
NextNBits( 3, “Label” )
For a complete description of NextNBits, see “NextNBits()” on page 42.
Example
See “Example for FireInspector-Specific Primitives” on page 60.
BitfieldDialog()
BitfieldDialog(<bitfield_identifier string>,
<width integer>)
Return value
None.
Parameter Meaning Default Value Comments
bitfield_identifier string The name of
the bitfield
data structure
Refers to the bitfield data structure from which to
get the data.
width integer The width, in
bits, of the
data field
Currently, width specification of other than 32
bits will yield unpredictable results.