ska_oso_oet.event.topics

class ska_oso_oet.event.topics.activity[source]

Root topic for events related to activities.

class lifecycle[source]

Topic for events related to activity lifecycle.

class running[source]

Emitted when an activity starts running.

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: ActivitySummary characterising the running activity

class pool[source]

Topic for events on characterisation of the activity pool.

class list[source]

Emitted when current activities and their status is enumerated.

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: list of ActivitySummary instances characterising
activites and their states.

class ska_oso_oet.event.topics.procedure[source]

Root topic for events related to procedures.

class lifecycle[source]

Topic for events related to procedure lifecycle.

class complete[source]

Emitted when a Procedure has completed successfully and is no longer available to be called.

msgDataSpec(request_id, result)[source]

msg_src: ID of Procedure that completed

class created[source]

Emitted when a procedure is created, i.e., a script is loaded and Python interpreter initialised.

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: ProcedureSummary characterising the created procedure

class failed[source]

Emitted when a procedure fails.

msgDataSpec(request_id, result)[source]

msg_src: component from which the event originated
request_id: unique identifier for this event
result: ProcedureSummary characterising the failed procedure

class stacktrace[source]

Announces cause of a Procedure failure.

msgDataSpec(stacktrace)[source]

msg_src: component from which the request originated
stacktrace: stacktrace as a string

class started[source]

Emitted when any user function in a procedure is running, i.e., script init is called

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: ProcedureSummary characterising the created procedure

class statechange[source]

Emitted when a procedure status changes.

To be amalgamated and rationalised with other lifecycle events to better handle rerunnable scripts.

msgDataSpec(new_state)[source]

msg_src: component from which the request originated
new_state: new state

class stopped[source]

Emitted when a procedure stops, e.g., script completes or is aborted.

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: ProcedureSummary characterising the created procedure

class pool[source]

Topic for events on characterisation of the process pool.

class list[source]

Emitted when current procedures and their status is enumerated.

msgDataSpec(request_id, result)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
result: list of ProcedureSummary instances characterising
procedures and their states.

class ska_oso_oet.event.topics.request[source]

Root topic for events emitted when a user or system component has made a request.

class activity[source]

Topic for user requests related to activities.

class list[source]

Emitted when a request to enumerate all activities is received.

msgDataSpec(request_id, activity_ids=None)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
activity_ids: Activity IDs to list.

class run[source]

Emitted when a request to run an activity is received.

msgDataSpec(request_id, cmd)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
cmd: ActivityCommand containing request parameters

class procedure[source]

Topic for user requests related to procedures.

class create[source]

Emitted when a request to create a procedure is received.

msgDataSpec(request_id, cmd)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
cmd: PrepareProcessCommand containing request parameters

class list[source]

Emitted when a request to enumerate all procedures is received.

msgDataSpec(request_id, pids=None)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
pids: Procedure IDs to list

class start[source]

Emitted when a request to start procedure execution is received.

msgDataSpec(request_id, cmd)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
cmd: StartProcessCommand containing request parameters

class stop[source]

Emitted when a request to stop a procedure is received.

msgDataSpec(request_id, cmd)[source]

msg_src: component from which the request originated
request_id: unique identifier for this request
cmd: StartProcessCommand containing request parameters

class ska_oso_oet.event.topics.sb[source]

Root topic for events emitted relating to Scheduling Blocks

class lifecycle[source]

Topic for events related to Scheduling Block lifecycle

class allocated[source]

Emitted when resources have been allocated within SB execution

msgDataSpec(sb_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID

class observation[source]

Topic for events related to executing an observation within an SB

class finished[source]

Emitted when an observation is finished

class failed[source]

Emitted when an error was encountered during observation execution

msgDataSpec(sb_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID

class succeeded[source]

Emitted when an observation is finished successfully

msgDataSpec(sb_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID

class started[source]

Emitted when an observation is started

msgDataSpec(sb_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID

class ska_oso_oet.event.topics.scan[source]

Root topic for events emitted relating to Scans in the context of SB execution

class lifecycle[source]

Topic for events related to SB scan lifecycle

class configure[source]

Emitted when sub-array resources are configured for a scan

class complete[source]

Emitted as scan configuration completes successfully.

msgDataSpec(sb_id, scan_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID
scan_id: Scan ID

class failed[source]

Emitted if scan configuration fails.

msgDataSpec(sb_id, scan_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID
scan_id: Scan ID

class started[source]

Emitted as scan configuration begins.

msgDataSpec(sb_id, scan_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID
scan_id: Scan ID

class end[source]

Emitted when a scan finishes

class failed[source]

Emitted when an error was encountered during a scan

msgDataSpec(sb_id, scan_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID

class succeeded[source]

Emitted when a scan completes successfully

msgDataSpec(sb_id, scan_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID
scan_id: Scan ID

class start[source]

Emitted when resources have been allocated within SB execution

msgDataSpec(sb_id)[source]

msg_src: component from which the request originated
sb_id: Scheduling Block ID
scan_id: Scan ID

class ska_oso_oet.event.topics.subarray[source]

Root topic for events emitted relating to individual Subarray activites

class configured[source]

Emitted when subarray has been configured

msgDataSpec(subarray_id)[source]

msg_src: component from which the request originated
sb_id: Subarray ID

class fault[source]

Topic for events emitted when subarray cannot be reached

msgDataSpec(subarray_id, error)[source]

msg_src: component from which the request originated
sb_id: Subarray ID
error: Error response received from Subarray

class resources[source]

Topic for events relating to Subarray resources

class allocated[source]

Emitted when resources have been allocated to a subarray

msgDataSpec(subarray_id)[source]

msg_src: component from which the request originated
sb_id: Subarray ID

class deallocated[source]

Emitted when resources have been deallocated from a subarray

msgDataSpec(subarray_id)[source]

msg_src: component from which the request originated
sb_id: Subarray ID

class scan[source]

Topic for events emitted when a scan is run on subarray

class finished[source]

Emitted when a scan is finished

msgDataSpec(subarray_id)[source]

msg_src: component from which the request originated
sb_id: Subarray ID

class started[source]

Emitted when a scan is started

msgDataSpec(subarray_id)[source]

msg_src: component from which the request originated
sb_id: Subarray ID

class ska_oso_oet.event.topics.user[source]

UNDOCUMENTED: created as parent without specification

class script[source]

UNDOCUMENTED: created as parent without specification

class announce[source]

UNDOCUMENTED: created without spec

msgDataSpec(msg)[source]

msg_src: component from which the request originated
msg: user message