Base Component Commands

class ska_csp_lmc_common.commands.base_commands.ComponentInit(component: Component, resources: Any | None = None, logger: Logger | None = None)

Class for handling the Subarray and Controller initialization and re- initialization.

_command_monitor() → None: Base method overridden to handle the connection with a CSP sub- system TANGO devices.

succeeded(): Does nothing but needed because inherit abstract class.

class ska_csp_lmc_common.commands.base_commands.ComponentDisconnect(component: Component, resources: Any | None = None, logger: Logger | None = None)

Class for handling the Subarray and Controller initialization and re- initialization.

_run(argument: Any | None = None, callback: Callable | None = None) → None: If not specialized simply calls the run method on the corresponding component.

succeeded(): Does nothing but needed because inherit abstract class.

class ska_csp_lmc_common.commands.base_commands.ComponentOn(component: Component, resources: Any | None = None, logger: Logger | None = None)

Class specialized to handle the On of a sub-system.

_run(argument: List | None = None, callback: Callable | None = None) → None: If not specialized simply calls the run method on the corresponding component.

succeeded() → bool: Return whether the command executed on a CSP sub-system completes successfully.

class ska_csp_lmc_common.commands.base_commands.ComponentOff(component: Component, logger: Logger | None = None)

Class specialized to handle the Off of a sub-system.

_run(argument: List | None = None, callback: Callable | None = None) → None: If not specialized simply calls the run method on the corresponding component.

succeeded() → bool: Return whether the command executed on a CSP sub-system completes successfully.

class ska_csp_lmc_common.commands.base_commands.ComponentStandby(component: Component, logger: Logger | None = None)

Class specialized to handle the Standby of a sub-system.

_run(argument: Any | None = None, callback: Callable | None = None) → None: If not specialized simply calls the run method on the corresponding component.

succeeded(): Return whether the command executed on a CSP sub-system completes successfully.

class ska_csp_lmc_common.commands.base_commands.ComponentReset(component: Component, logger: Logger | None = None)

Class specialized to handle the Reset of a sub-system.

succeeded() → bool: Return whether the command executed on a CSP sub-system completes successfully.

class ska_csp_lmc_common.commands.base_commands.ComponentNop(component: Component, logger: Logger | None = None)

Class for Not Operative Command (NOP).

property expected_condition: Return the expected condition

endscan_request_pending(): Whether the endscan event is set

_run_nop_command()

Whether the NOP command can be executed

When a NOP command is part of an interruptable command (Configure, Scan, ObsReset) the execution of its run method is skipped when:

no event is set
an event is set but the command the NOP command is related to
another event

run() → None

Execute a wait loop.

This command, when not skipped, waits for a specific condition.

succeeded() → bool

Return whether the required conditions are satisfied.

If no conditions are specified, the command waits for the configured timeout.

class ska_csp_lmc_common.commands.base_commands.ComponentForceHealthState(component: Component, resources: Any | None = None, logger: Logger | None = None)

Class specialized to handle the ForceHealthState of a sub-system.

run(argument: Any | None = None, callback: Callable | None = None) → None: Method to execute the command on the receiver component.

succeeded(): Return whether the command executed on a CSP sub-system completes successfully.