ska_tmc_sdpsubarrayleafnode package

Subpackages

• ska_tmc_sdpsubarrayleafnode.commands package
  • Submodules
  • ska_tmc_sdpsubarrayleafnode.commands.sdp_sln_command module
    • SdpSLNCommand
      • SdpSLNCommand.check_op_state()
      • SdpSLNCommand.check_unresponsive()
      • SdpSLNCommand.do()
      • SdpSLNCommand.do_low()
      • SdpSLNCommand.do_mid()
      • SdpSLNCommand.init_adapter()
      • SdpSLNCommand.init_adapter_low()
      • SdpSLNCommand.init_adapter_mid()
      • SdpSLNCommand.update_task_status()
    • task_callback_default()
  • ska_tmc_sdpsubarrayleafnode.commands.off_command module
    • Off
      • Off.do()
      • Off.off()
  • ska_tmc_sdpsubarrayleafnode.commands.on_command module
    • On
      • On.do()
      • On.on()
  • ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command module
    • AssignResources
      • AssignResources.assign_resources()
      • AssignResources.do()
  • ska_tmc_sdpsubarrayleafnode.commands.configure_command module
    • Configure
      • Configure.configure()
      • Configure.do()
  • ska_tmc_sdpsubarrayleafnode.commands.end_command module
    • End
      • End.do()
      • End.end()
  • ska_tmc_sdpsubarrayleafnode.commands.end_scan_command module
    • EndScan
      • EndScan.do()
      • EndScan.end_scan()
  • ska_tmc_sdpsubarrayleafnode.commands.release_resources_command module
    • ReleaseAllResources
      • ReleaseAllResources.do()
      • ReleaseAllResources.release_resources()
  • ska_tmc_sdpsubarrayleafnode.commands.restart_command module
    • Restart
      • Restart.do()
      • Restart.restart()
  • ska_tmc_sdpsubarrayleafnode.commands.scan_command module
    • Scan
      • Scan.do()
      • Scan.scan()
  • Module contents
    • Abort
      • Abort.do()
    • AssignResources
      • AssignResources.assign_resources()
      • AssignResources.do()
    • Configure
      • Configure.configure()
      • Configure.do()
    • End
      • End.do()
      • End.end()
    • EndScan
      • EndScan.do()
      • EndScan.end_scan()
    • Off
      • Off.do()
      • Off.off()
    • On
      • On.do()
      • On.on()
    • ReleaseAllResources
      • ReleaseAllResources.do()
      • ReleaseAllResources.release_resources()
    • Restart
      • Restart.do()
      • Restart.restart()
    • Scan
      • Scan.do()
      • Scan.scan()
• ska_tmc_sdpsubarrayleafnode.manager package
  • Submodules
  • ska_tmc_sdpsubarrayleafnode.manager.component_manager module
    • SdpSLNComponentManager
      • SdpSLNComponentManager.abort_commands()
      • SdpSLNComponentManager.assign_resources()
      • SdpSLNComponentManager.cmd_ended_cb()
      • SdpSLNComponentManager.configure()
      • SdpSLNComponentManager.end()
      • SdpSLNComponentManager.end_scan()
      • SdpSLNComponentManager.generate_command_result()
      • SdpSLNComponentManager.get_device()
      • SdpSLNComponentManager.get_obs_state()
      • SdpSLNComponentManager.is_command_allowed()
      • SdpSLNComponentManager.lrc_result
      • SdpSLNComponentManager.off()
      • SdpSLNComponentManager.on()
      • SdpSLNComponentManager.raise_invalid_obsstate_error()
      • SdpSLNComponentManager.release_all_resources()
      • SdpSLNComponentManager.restart()
      • SdpSLNComponentManager.scan()
      • SdpSLNComponentManager.standby()
      • SdpSLNComponentManager.start_communicating()
      • SdpSLNComponentManager.stop()
      • SdpSLNComponentManager.stop_communicating()
      • SdpSLNComponentManager.update_command_result()
      • SdpSLNComponentManager.update_device_obs_state()
      • SdpSLNComponentManager.update_device_ping_failure()
      • SdpSLNComponentManager.update_event_failure()
      • SdpSLNComponentManager.update_ping_info()
  • Module contents
    • SdpSLNComponentManager
      • SdpSLNComponentManager.abort_commands()
      • SdpSLNComponentManager.assign_resources()
      • SdpSLNComponentManager.cmd_ended_cb()
      • SdpSLNComponentManager.configure()
      • SdpSLNComponentManager.end()
      • SdpSLNComponentManager.end_scan()
      • SdpSLNComponentManager.generate_command_result()
      • SdpSLNComponentManager.get_device()
      • SdpSLNComponentManager.get_obs_state()
      • SdpSLNComponentManager.is_command_allowed()
      • SdpSLNComponentManager.lrc_result
      • SdpSLNComponentManager.off()
      • SdpSLNComponentManager.on()
      • SdpSLNComponentManager.raise_invalid_obsstate_error()
      • SdpSLNComponentManager.release_all_resources()
      • SdpSLNComponentManager.restart()
      • SdpSLNComponentManager.scan()
      • SdpSLNComponentManager.standby()
      • SdpSLNComponentManager.start_communicating()
      • SdpSLNComponentManager.stop()
      • SdpSLNComponentManager.stop_communicating()
      • SdpSLNComponentManager.update_command_result()
      • SdpSLNComponentManager.update_device_obs_state()
      • SdpSLNComponentManager.update_device_ping_failure()
      • SdpSLNComponentManager.update_event_failure()
      • SdpSLNComponentManager.update_ping_info()
    • SdpSLNEventReceiver
      • SdpSLNEventReceiver.handle_obs_state_event()
      • SdpSLNEventReceiver.run()
      • SdpSLNEventReceiver.subscribe_events()

Submodules

ska_tmc_sdpsubarrayleafnode._sdp_subarray_leaf_node module

SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation. It also acts as a SDP contact point for Subarray Node for observation execution

class ska_tmc_sdpsubarrayleafnode.sdp_subarray_leaf_node.SdpSubarrayLeafNode(*args: Any, **kwargs: Any)

Bases: SKABaseDevice

SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation.

class InitCommand(*args: Any, **kwargs: Any)

Bases: InitCommand

A class for the TMC SdpSubarrayLeafNode’s init_device() method.

do(*args, **kwargs) → Tuple[ska_tango_base.commands.ResultCode, str]

Initializes the attributes and properties of the SdpSubarrayLeafNode.

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

rtype:

(ResultCode, str)

always_executed_hook()

create_component_manager()

Returns Sdp Subarray Leaf Node component manager object

delete_device() → None

init_command_objects() → None

Initialises the command handlers for commands supported by this device.

init_device()

is_Abort_allowed() → bool

Checks whether Abort command is allowed to be run in current device state

Returns:

True if Abort command is allowed to be run in current device state

rtype:

boolean

is_AssignResources_allowed() → bool

Checks whether AssignResources command is allowed to be run in current device state. :return: True if AssignResources command is allowed to be run in current device state.

Return type:

boolean

is_Configure_allowed() → bool

Checks whether Configure command is allowed to be run in current device state. :return: True if Configure command is allowed to be run in current device state :rtype: boolean

is_EndScan_allowed()

Checks whether this command is allowed to be run in current device state. :returns: True if this command is allowed to be run in current device state.

rtype:

boolean

is_End_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state.

Return type:

boolean

is_Off_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

is_On_allowed() → Union[bool, ska_tmc_common.exceptions.InvalidObsStateError, ska_tmc_common.exceptions.DeviceUnresponsive, ska_tmc_common.exceptions.CommandNotAllowed]

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

is_ReleaseAllResources_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state.

Return type:

boolean

is_Restart_allowed() → bool

Checks whether Restart command is allowed to be run in current device

state

return:

True if Restart command is allowed to be run in current device state

rtype:

boolean

is_Scan_allowed() → bool

Checks whether Scan command is allowed to be run in current device state. :return: True if Scan command is allowed to be run in current device state :rtype: boolean

read_isSubsystemAvailable() → bool

Read method for issubsystemavailable

read_lastDeviceInfoChanged() → str

Return the last device info change

read_sdpSubarrayDevName() → str

Return the sdpsubarraydevname attribute.

read_sdpSubarrayObsState() → ska_tango_base.control_model.ObsState

Reads the current observation state of the SDP subarray

update_availablity_callback(availablity)

Change event callback for isSubsystemAvailable

update_device_callback(dev_info: ska_tmc_common.device_info.SdpSubarrayDeviceInfo) → None

Updates device callback info

update_lrcr_callback(lrc_result: Tuple[str, Union[ska_tango_base.commands.ResultCode, ska_tango_base.executor.TaskStatus, Exception, str]])

Change event callback for longRunningCommandResult

update_sdp_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) → None

Updates SDP Subarray ObsState

write_sdpSubarrayDevName(value: str) → None

Set the sdpsubarraydevname attribute.

ska_tmc_sdpsubarrayleafnode.sdp_subarray_leaf_node.main(args=None, **kwargs)

Runs the SdpSubarrayLeafNode Tango device. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

Returns:

integer. Exit code of the run method.

Module contents

SdpSubarrayLeafNode