deviceaccess.TransferGroup

class deviceaccess.TransferGroup

Bases: pybind11_object

Group of TransferElements for coordinated read and write operations.

A TransferGroup allows triggering one read or write call for all added accessors.

__init__(self: deviceaccess.TransferGroup) → None: Create an empty TransferGroup.

Methods

`__init__`(self)	Create an empty TransferGroup.
`addAccessor`(self, element)	Add an accessor to the group.
`isReadOnly`(self)	Check whether all accessors in the group are read only.
`isReadable`(self)	Check whether all accessors in the group are readable.
`isWriteable`(self)	Check whether all accessors in the group are writable.
`read`(self)	Trigger a read transfer for all accessors in the group.
`write`(self, versionNumber)	Trigger a write transfer for all accessors in the group.

__init__(self: deviceaccess.TransferGroup) → None: Create an empty TransferGroup.

addAccessor(self: deviceaccess.TransferGroup, element: deviceaccess.TransferElementBase) → None

Add an accessor to the group.

A TransferElement can only be part of one TransferGroup. TransferGroup can only be used with transfer elements that do not have AccessMode.wait_for_new_data.

Args:
element (TransferElementBase): Accessor to add to the group.

isReadOnly(self: deviceaccess.TransferGroup) → bool

Check whether all accessors in the group are read only.

Returns:
bool: True if all accessors are read only, false otherwise.

isReadable(self: deviceaccess.TransferGroup) → bool

Check whether all accessors in the group are readable.

Returns:
bool: True if all accessors are readable, false otherwise.

isWriteable(self: deviceaccess.TransferGroup) → bool

Check whether all accessors in the group are writable.

Returns:
bool: True if all accessors are writable, false otherwise.

read(self: deviceaccess.TransferGroup) → None: Trigger a read transfer for all accessors in the group.

write(self: deviceaccess.TransferGroup, versionNumber: deviceaccess.VersionNumber = <PyVersionNumber(versionNumber=v0)>) → None

Trigger a write transfer for all accessors in the group.

Args:
versionNumber (VersionNumber): Optional version number used for the write operation. If not set, a new version number is generated.