ska_oso_oet.event.topics

class ska_oso_oet.event.topics.activity

Root topic for events related to activities.

class lifecycle

Topic for events related to activity lifecycle.

class running

Emitted when an activity starts running.

msgDataSpec(request_id, result)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• result: ActivitySummary characterising the running activity

class statechange

Emitted when an activity status changes.

msgDataSpec(new_state)

• msg_src: component from which the request originated

• new_state: new state

class pool

Topic for events on characterisation of the activity pool.

class list

Emitted when current activities and their status is enumerated.

msgDataSpec(request_id, result)

• 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.operator

Root topic for operator override events.

class override

Topic for operator override state responses.

class state

Emitted when the current override state is queried.

msgDataSpec(request_id, result)

• msg_src: component from which the response originated

• request_id: unique identifier for this request

• result: ScriptContext with current override state

class wait_for_qa_ready

Topic for QA wait-for-ready override events.

class disable

Disable QA wait-for-ready override.

msgDataSpec()

• msg_src: component from which the request originated

class enable

Enable QA wait-for-ready override for all scripts on this subarray. Persists until disabled.

msgDataSpec()

• msg_src: component from which the request originated

class override

One-shot signal to override QA wait-for-ready for the current scan.

msgDataSpec()

• msg_src: component from which the request originated

class ska_oso_oet.event.topics.procedure

Root topic for events related to procedures.

class lifecycle

Topic for events related to procedure lifecycle.

class complete

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

msgDataSpec(request_id, result)

• msg_src: ID of Procedure that completed

class created

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

msgDataSpec(request_id, result)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• result: ProcedureSummary characterising the created procedure

class failed

Emitted when a procedure fails.

msgDataSpec(request_id, result)

• msg_src: component from which the event originated

• request_id: unique identifier for this event

• result: ProcedureSummary characterising the failed procedure

class ready

Emitted when a procedure is ready to accept run commands, i.e., script function has completed or init() was not required.

msgDataSpec(request_id, result)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• result: ProcedureSummary characterising the ready procedure

class stacktrace

Announces cause of a Procedure failure.

msgDataSpec(stacktrace)

• msg_src: component from which the request originated

• stacktrace: stacktrace as a string

class started

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

msgDataSpec(request_id, result)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• result: ProcedureSummary characterising the created procedure

class statechange

Emitted when a procedure status changes.

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

msgDataSpec(new_state)

• msg_src: component from which the request originated

• new_state: new state

class stopped

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

msgDataSpec(request_id, result)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• result: ProcedureSummary characterising the created procedure

class management

Topic for management commands between ProcessManager and main_loop.

class create

Request to create a ScriptWorker process.

msgDataSpec(pid, script, init_args)

• msg_src: component from which the request originated

• pid: PID assigned by ProcessManager

• script: ExecutableScript to execute

• init_args: ProcedureInput initialisation arguments

class created

Response to procedure.management.create request.

msgDataSpec(pid, success, error=None)

• msg_src: component from which the response originated

• pid: PID from the create request

• success: bool indicating if creation succeeded

• error: str | None - full exception traceback if failed

class run

Request to run a function in a prepared procedure.

msgDataSpec(pid, fn_name, run_args)

• msg_src: component from which the request originated

• pid: PID of procedure to run

• fn_name: name of function to call

• run_args: ProcedureInput runtime arguments

class stop

Request to stop a running procedure.

msgDataSpec(pid)

• msg_src: component from which the request originated

• pid: PID of procedure to stop

class pool

Topic for events on characterisation of the process pool.

class list

Emitted when current procedures and their status is enumerated.

msgDataSpec(request_id, result)

• 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

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

class activity

Topic for user requests related to activities.

class list

Emitted when a request to enumerate all activities is received.

msgDataSpec(request_id, activity_ids=None)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• activity_ids: Activity IDs to list.

class run

Emitted when a request to run an activity is received.

msgDataSpec(request_id, cmd)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• cmd: ActivityCommand containing request parameters

class operator

Topic for user requests related to operator overrides.

class override

Topic for requests to query operator override state.

class state

Emitted when a request to query override state is received.

msgDataSpec(request_id)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

class procedure

Topic for user requests related to procedures.

class create

Emitted when a request to create a procedure is received.

msgDataSpec(request_id, cmd)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• cmd: PrepareProcessCommand containing request parameters

class list

Emitted when a request to enumerate all procedures is received.

msgDataSpec(request_id, pids=None)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• pids: Procedure IDs to list

class start

Emitted when a request to start procedure execution is received.

msgDataSpec(request_id, cmd)

• msg_src: component from which the request originated

• request_id: unique identifier for this request

• cmd: StartProcessCommand containing request parameters

class stop

Emitted when a request to stop a procedure is received.

msgDataSpec(request_id, cmd)

• 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

Root topic for events emitted relating to Scheduling Blocks

class lifecycle

Topic for events related to Scheduling Block lifecycle

class started

Emitted when an observation is started

msgDataSpec(sbi_id)

• msg_src: component from which the request originated

• sbi_id: Scheduling Block Instance ID

class ska_oso_oet.event.topics.test

Root topic for test events.

These topics are used by tests to synchronize with script execution without requiring Barrier objects (which cannot be pickled).

class script

Topic for test events from script execution.

class finished

Emitted when an observation is finished

class failed

Emitted when an error was encountered during observation execution

msgDataSpec(sbi_id)

• msg_src: component from which the request originated

• sbi_id: Scheduling Block Instance ID

class succeeded

Emitted when an observation is finished successfully

msgDataSpec(sbi_id)

• msg_src: component from which the request originated

• sbi_id: Scheduling Block Instance ID

class init_started

Emitted when a test script’s init() function starts.

Note: No msgDataSpec defined as these messages have no required args.

class main_started

Emitted when a test script’s main() function starts.

Note: No msgDataSpec defined as these messages have no required args.