Getnbits() – Teledyne LeCroy Merlins Wand - CSL manual (CATC Scripting Language Manual) User Manual

Page 39

Advertising
background image

33

CATC Scripting Language for Bluetooth Analyzers

CATC

Manual Ver. 1.21

A hash mark (

#

) will prepend a

0

to an octal number when used with the conversion

character

o

. If

#

is used with

x

or

X

, it will prepend

0x

or

0X

to a hexadecimal

number.

A zero (

0

) will pad the field with zeros instead of with spaces.

Field width specification is a positive integer that defines the field width, in spaces, of the
converted argument. If the number of characters in the argument is smaller than the field
width, then the field is padded with spaces. If the argument has more characters than the
field width has spaces, then the field will expand to accommodate the argument.

GetNBits()

GetNBits (<bit_source list or raw>, <bit_offset integer>, <bit_count

integer>)

Return value

integer, list or raw.

Comments

Reads

bit_count

bits from

bit_source

starting at

bit_offset

. Will

return null if

bit_offset

+

bit_count

exceeds the number of bits in

bit_source

. If

bit_count

is 32 or less, the result will be returned as an

integer. Otherwise, the result will be returned in a list format that is the same as the
input format.

GetNBits

also sets up the bit data source and global bit offset used

by

NextNBits

and

PeekNBits

. Note that bits are indexed starting at bit 0.

Example

raw = 'FOFO';

# 1111000011110000 binary

result = GetNBits ( raw, 2, 4 );

Trace ( "result = ", result );

The output would be

result = C

# The result is given in hexadecimal. The result

in binary is 1100.

In the call to

GetNBits

: starting at bit 2, reads 4 bits (1100), and returns the value

0xC.

Parameter

Meaning

Default Value Comments

bit_source list, raw, or

integer

Can be an integer value (4 bytes) or a list of inte-
gers that are interpreted as bytes.

bit_offset integer

Index of bit to

start reading

from

bit_count integer

Number of

bits to read

Advertising