Model

The Model class define a data type for use with a Block.

class pyrogue.Model(*args, **kwargs)

Class which describes how a data type is represented and accessed using the Rogue Variables and Blocks

Parameters:

• bitSize (int) – Number of bits being represented

• binPoint (int) – Huh?

Variables:

• name (str) – String representation of the Model type

• fstring (str) – Not sure what this is, Where is it used?

• encoding (str) – Encoding type for converting between string and byte arrays. i.e. UTF-8

• pytype (int) – Python type class.

• defaultdisp (str) – Default display formatting string. May be overriden by the Variable disp parameter.

• signed (bool) – Flag indicating if value is signed. Default=False

• endianness (str) – Endianness indicator. ‘little’ or ‘big’. Default=’little’

• bitReverse (bool) – Bit reversal flag.

• modelId (int) – Block processing ID. See interfaces_memory_constants_ptype

• isBigEndian (bool) – True if endianness = ‘big’

• ndType (np.dtype) – numpy type value (bool, int32, int64, uint32, uin64, float32, float64)

toBytes(value)

Convert the python value to byte array.

Parameters:

value (obj) – Python value to convert

fromBytes(ba)

Convert the python value to byte array.

Parameters:

ba (bytearray) – Byte array to extract value from

fromString(string)

Convert the string to a python value.

Parameters:

string (str) – String representation of the value

minValue()

Return the minimum value for the Model type

maxValue()

Return the maximum value for the Model type

Standard Models

The following are pre-defined models for various data types.

UInt

class pyrogue.UInt(*args, **kwargs)

Model class for unsigned integers

pytype

alias of int

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

fromString(string)

Parameters:

string

UIntBE

class pyrogue.UIntBE(*args, **kwargs)

Model class for big endian unsigned integers

UIntReversed

class pyrogue.UIntReversed(*args, **kwargs)

Model class for unsigned integers, stored in reverse bit order

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

Int

class pyrogue.Int(*args, **kwargs)

Model class for integers

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

fromString(string)

Parameters:

string

IntBE

class pyrogue.IntBE(*args, **kwargs)

Model class for big endian integers

Bool

class pyrogue.Bool(*args, **kwargs)

Model class for booleans

pytype

alias of bool

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

fromString(string)

Parameters:

string

String

class pyrogue.String(*args, **kwargs)

Model class for strings

pytype

alias of str

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

fromString(string)

Parameters:

string

Float

class pyrogue.Float(*args, **kwargs)

Model class for 32-bit floats

pytype

alias of float

toBytes(value)

Parameters:

value

fromBytes(ba)

Parameters:

ba

fromString(string)

Parameters:

string

FloatBE

class pyrogue.FloatBE(*args, **kwargs)

Model class for 32-bit floats stored as big endian

Double

class pyrogue.Double(*args, **kwargs)

Model class for 64-bit floats

DoubleBE

class pyrogue.DoubleBE(*args, **kwargs)

Model class for 64-bit floats stored as big endian

Fixed

class pyrogue.Fixed(*args, **kwargs)

Model class for fixed point signed integers

Parameters:

• bitSize (int) – Specifies the total number of bits, including the binary point bit width.

• binPoint (int) – Specifies the bit location of the binary point, where bit zero is the least significant bit.

pytype

alias of float

UFixed

class pyrogue.UFixed(*args, **kwargs)

Model class for fixed point unsigned integers

Parameters:

• bitSize (int) – Specifies the total number of bits, including the binary point bit width.

• binPoint (int) – Specifies the bit location of the binary point, where bit zero is the least significant bit.

pytype

alias of float