bec_lib.scan_report.ScanReport

class ScanReport

Bases: object

Scan Report class that provides a convenient way to access the status of a scan request.

Methods

from_request	Create a ScanReport from a request
wait	wait for the request to complete

Attributes

queue_item	get the queue item
scan	get the scan item
status	returns the current status of the request

classmethod from_request(request: messages.ScanQueueMessage, client: BECClient = None) → ScanReport

Create a ScanReport from a request

Parameters:

• request (messages.ScanQueueMessage) – request to create the report from

• client (BECClient, optional) – BECClient instance. Defaults to None.

Returns:

ScanReport instance

Return type:

ScanReport

property queue_item

get the queue item

property scan

get the scan item

property status

returns the current status of the request

wait(timeout: float | None = None) → ScanReport

wait for the request to complete

Parameters:

timeout (float, optional) – timeout in seconds. Defaults to None.

Raises:

TimeoutError – if the timeout is reached

Returns:

ScanReport instance

Return type:

ScanReport