mbserver._MemoryBlockRegs Class Reference

Inheritance diagram for mbserver._MemoryBlockRegs:

Collaboration diagram for mbserver._MemoryBlockRegs:

Public Member Functions
int	__getitem__ (self, int index)
int	__setitem__ (self, int index, int value)
int	getint8 (self, int regoffset)
	setint8 (self, int regoffset, int value)
int	getuint8 (self, int regoffset)
	setuint8 (self, int regoffset, int value)
int	getint16 (self, int offset)
	setint16 (self, int offset, int value)
int	getuint16 (self, int offset)
	setuint16 (self, int offset, int value)
int	getint32 (self, int offset)
	setint32 (self, int offset, int value)
int	getuint32 (self, int offset)
	setuint32 (self, int offset, int value)
int	getint64 (self, int offset)
	setint64 (self, int offset, int value)
int	getuint64 (self, int offset)
	setuint64 (self, int offset, int value)
int	getfloat (self, int offset)
	setfloat (self, int offset, float value)
int	getdouble (self, int offset)
	setdouble (self, int offset, float value)
str	getstring (self, int regoffset, int bytecount)
	setstring (self, int regoffset, 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)

Protected Attributes
str	_byteorder = 'big':

Detailed Description

Class for the register memory objects: mem3x, mem4x.

   More details. 

Member Function Documentation

__getitem__()

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

Return uint16 register at `index`.

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

__setitem__()

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

Set uint16 register at `index`.

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

getdouble()

int mbserver._MemoryBlockRegs.getdouble	(		self,
		int	offset )

Return 64-bit float from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getfloat()

int mbserver._MemoryBlockRegs.getfloat	(		self,
		int	offset )

Return 32-bit float from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getint16()

int mbserver._MemoryBlockRegs.getint16	(		self,
		int	offset )

Return int16 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getint32()

int mbserver._MemoryBlockRegs.getint32	(		self,
		int	offset )

Return int32 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getint64()

int mbserver._MemoryBlockRegs.getint64	(		self,
		int	offset )

Return int64 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getint8()

int mbserver._MemoryBlockRegs.getint8	(		self,
		int	regoffset )

Return int8 value from register memory at `regoffset` (first byte).

Args:
    regoffset  Register offset (0-based).

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

Note:
    Since v0.4.4, parameter renamed from `byteoffset` to `regoffset`.

getstring()

str mbserver._MemoryBlockRegs.getstring	(		self,
		int	regoffset,
		int	bytecount )

Return string from register memory; same as `getregstring()`.

See Also:
    getregstring()

Note:
    Since v0.4.2

getuint16()

int mbserver._MemoryBlockRegs.getuint16	(		self,
		int	offset )

Return uint16 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getuint32()

int mbserver._MemoryBlockRegs.getuint32	(		self,
		int	offset )

Return uint32 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getuint64()

int mbserver._MemoryBlockRegs.getuint64	(		self,
		int	offset )

Return uint64 value from register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).

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

getuint8()

int mbserver._MemoryBlockRegs.getuint8	(		self,
		int	regoffset )

Return uint8 value from register memory at `regoffset` (first byte).

Args:
    regoffset  Register offset (0-based).

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

Note:
    Since v0.4.4, parameter renamed from `byteoffset` to `regoffset`.

setdouble()

mbserver._MemoryBlockRegs.setdouble	(		self,
		int	offset,
		float	value )

Write 64-bit float to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   64-bit float value.

Note:
    Does nothing if out of range.

setfloat()

mbserver._MemoryBlockRegs.setfloat	(		self,
		int	offset,
		float	value )

Write 32-bit float to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   32-bit float value.

Note:
    Does nothing if out of range.

setint16()

mbserver._MemoryBlockRegs.setint16	(		self,
		int	offset,
		int	value )

Write int16 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [-32768:32767].

Note:
    Does nothing if out of range.

setint32()

mbserver._MemoryBlockRegs.setint32	(		self,
		int	offset,
		int	value )

Write int32 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [-2147483648:2147483647].

Note:
    Does nothing if out of range.

setint64()

mbserver._MemoryBlockRegs.setint64	(		self,
		int	offset,
		int	value )

Write int64 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [-9223372036854775808:9223372036854775807].

Note:
    Does nothing if out of range.

setint8()

mbserver._MemoryBlockRegs.setint8	(		self,
		int	regoffset,
		int	value )

Write int8 value to register memory at `regoffset` (first byte).

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

Note:
    Since v0.4.4, parameter renamed from `byteoffset` to `regoffset`.

setstring()

mbserver._MemoryBlockRegs.setstring	(		self,
		int	regoffset,
		str	value )

Write string to register memory; same as `setregstring()`.

See Also:
    setregstring()

Note:
    Since v0.4.2

setuint16()

mbserver._MemoryBlockRegs.setuint16	(		self,
		int	offset,
		int	value )

Write uint16 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [0:65535].

Note:
    Does nothing if out of range.

setuint32()

mbserver._MemoryBlockRegs.setuint32	(		self,
		int	offset,
		int	value )

Write uint32 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [0:4294967295].

Note:
    Does nothing if out of range.

setuint64()

mbserver._MemoryBlockRegs.setuint64	(		self,
		int	offset,
		int	value )

Write uint64 value to register memory starting at `offset`.

Args:
    offset  Offset of the first register (0-based).
    value   Integer value in range [0:18446744073709551615].

Note:
    Does nothing if out of range.

setuint8()

mbserver._MemoryBlockRegs.setuint8	(		self,
		int	regoffset,
		int	value )

Write uint8 value to register memory at `regoffset` (first byte).

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

Note:
    Since v0.4.4, parameter renamed from `byteoffset` to `regoffset`.

---

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

• mbserver.py