mbserver._MemoryBlockBits Class Reference

Inheritance diagram for mbserver._MemoryBlockBits:

Collaboration diagram for mbserver._MemoryBlockBits:

Public Member Functions
int	__getitem__ (self, int index)
	__setitem__ (self, int index, int value)
int	getint8 (self, int bitoffset)
	setint8 (self, int bitoffset, int value)
int	getuint8 (self, int bitoffset)
	setuint8 (self, int bitoffset, int value)
int	getint16 (self, int bitoffset)
	setint16 (self, int bitoffset, int value)
int	getuint16 (self, int bitoffset)
	setuint16 (self, int bitoffset, int value)
int	getint32 (self, int bitoffset)
	setint32 (self, int bitoffset, int value)
int	getuint32 (self, int bitoffset)
	setuint32 (self, int bitoffset, int value)
int	getint64 (self, int bitoffset)
	setint64 (self, int bitoffset, int value)
int	getuint64 (self, int bitoffset)
	setuint64 (self, int bitoffset, int value)
float	getfloat (self, int bitoffset)
	setfloat (self, int bitoffset, float value)
float	getdouble (self, int bitoffset)
	setdouble (self, int bitoffset, float value)
str	getstring (self, int bitoffset, int bytecount)
	setstring (self, int bitoffset, str value)
Public Member Functions inherited from mbserver._MemoryBlock
int	getid (self)
str	getbyteorder (self)
str	getregisterorder (self)
bytes	getbytes (self, int byteoffset, int bytecount)
bytearray	getbytearray (self, int byteoffset, int bytecount)
	setbytes (self, int byteoffset, Union[bytes, bytearray] value)
bytearray	getbitbytearray (self, int bitoffset, int bitcount)
bytes	getbitbytes (self, int bitoffset, int bitcount)
	setbitbytes (self, int bitoffset, int bitcount, Union[bytes, bytearray] value)
bool	getbit (self, int bitoffset)
	setbit (self, int bitoffset, bool value)
str	getbitstring (self, int bitoffset, int bytecount)
	setbitstring (self, int bitoffset, str value)
str	getbytestring (self, int byteoffset, int bytecount)
	setbytestring (self, int byteoffset, str value)
str	getregstring (self, int regoffset, int bytecount)
	setregstring (self, int regoffset, str value)

Detailed Description

Class for the bit memory objects: mem0x, mem1x.

   More details. 

Member Function Documentation

__getitem__()

int mbserver._MemoryBlockBits.__getitem__	(		self,
		int	index )

Return bit value at `index`.

Same as `getbit()` but raises `IndexError` if out of range.

__setitem__()

mbserver._MemoryBlockBits.__setitem__	(		self,
		int	index,
		int	value )

Set bit value at `index`.

Same as `setbit()` but raises `IndexError` if out of range.

getdouble()

float mbserver._MemoryBlockBits.getdouble	(		self,
		int	bitoffset )

Return 64-bit float from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Float value, or 0.0 if out of range.

getfloat()

float mbserver._MemoryBlockBits.getfloat	(		self,
		int	bitoffset )

Return 32-bit float from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Float value, or 0.0 if out of range.

getint16()

int mbserver._MemoryBlockBits.getint16	(		self,
		int	bitoffset )

Return int16 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [-32768:32767], or 0 if out of range.

getint32()

int mbserver._MemoryBlockBits.getint32	(		self,
		int	bitoffset )

Return int32 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [-2147483648:2147483647], or 0 if out of range.

getint64()

int mbserver._MemoryBlockBits.getint64	(		self,
		int	bitoffset )

Return int64 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [-9223372036854775808:9223372036854775807], or 0 if out of range.

getint8()

int mbserver._MemoryBlockBits.getint8	(		self,
		int	bitoffset )

Return int8 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [-128:127], or 0 if out of range.

getstring()

str mbserver._MemoryBlockBits.getstring	(		self,
		int	bitoffset,
		int	bytecount )

Return string from bit memory; same as `getbitstring()`.

See Also:
    getbitstring()

Note:
    Since v0.4.2

getuint16()

int mbserver._MemoryBlockBits.getuint16	(		self,
		int	bitoffset )

Return uint16 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [0:65535], or 0 if out of range.

getuint32()

int mbserver._MemoryBlockBits.getuint32	(		self,
		int	bitoffset )

Return uint32 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [0:4294967295], or 0 if out of range.

getuint64()

int mbserver._MemoryBlockBits.getuint64	(		self,
		int	bitoffset )

Return uint64 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [0:18446744073709551615], or 0 if out of range.

getuint8()

int mbserver._MemoryBlockBits.getuint8	(		self,
		int	bitoffset )

Return uint8 value from bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).

Returns:
    Integer in range [0:255], or 0 if out of range.

setdouble()

mbserver._MemoryBlockBits.setdouble	(		self,
		int	bitoffset,
		float	value )

Write 64-bit float into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Float value to write.

Note:
    Does nothing if out of range.

setfloat()

mbserver._MemoryBlockBits.setfloat	(		self,
		int	bitoffset,
		float	value )

Write 32-bit float into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Float value to write.

Note:
    Does nothing if out of range.

setint16()

mbserver._MemoryBlockBits.setint16	(		self,
		int	bitoffset,
		int	value )

Write int16 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [-32768:32767].

Note:
    Does nothing if out of range.

setint32()

mbserver._MemoryBlockBits.setint32	(		self,
		int	bitoffset,
		int	value )

Write int32 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [-2147483648:2147483647].

Note:
    Does nothing if out of range.

setint64()

mbserver._MemoryBlockBits.setint64	(		self,
		int	bitoffset,
		int	value )

Write int64 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [-9223372036854775808:9223372036854775807].

Note:
    Does nothing if out of range.

setint8()

mbserver._MemoryBlockBits.setint8	(		self,
		int	bitoffset,
		int	value )

Write int8 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [-128:127].

Note:
    Does nothing if out of range.

setstring()

mbserver._MemoryBlockBits.setstring	(		self,
		int	bitoffset,
		str	value )

Write string to bit memory; same as `setbitstring()`.

See Also:
    setbitstring()

Note:
    Since v0.4.2

setuint16()

mbserver._MemoryBlockBits.setuint16	(		self,
		int	bitoffset,
		int	value )

Write uint16 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [0:65535].

Note:
    Does nothing if out of range.

setuint32()

mbserver._MemoryBlockBits.setuint32	(		self,
		int	bitoffset,
		int	value )

Write uint32 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [0:4294967295].

Note:
    Does nothing if out of range.

setuint64()

mbserver._MemoryBlockBits.setuint64	(		self,
		int	bitoffset,
		int	value )

Write uint64 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [0:18446744073709551615].

Note:
    Does nothing if out of range.

setuint8()

mbserver._MemoryBlockBits.setuint8	(		self,
		int	bitoffset,
		int	value )

Write uint8 value into bit memory starting at `bitoffset`.

Args:
    bitoffset  Bit offset (0-based).
    value      Integer in range [0:255].

Note:
    Does nothing if out of range.

---

The documentation for this class was generated from the following file:

• mbserver.py