ska_tmc_mccssubarrayleafnode package

Link to the TMC User documentation is here.

Subpackages

Submodules

ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node module

MCCSSubarrayLeafnode acts as a contact point for the MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray.

class ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node.LowTmcLeafNodeMccsSubarray(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

MCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray.

InitCommand = None

create_component_manager() → MccsSLNComponentManager

Method for creating Mccs Subarray Leaf Node component manager object

Returns:: Returns Mccs Subarray Leaf Node component manager object

delete_device() → None: Clean up resources and stop any running components when the device is deleted.

init_device(): Initialize the device and set up attributes and event handling.

is_Abort_allowed() → bool

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

Returns:: True if Abort command is allowed.
Return type:: bool

is_Configure_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → bool

Check if Configure command is allowed.

Parameters:: request_type (LRCReqType) – Request type.
Returns:: True if allowed.
Return type:: bool

is_EndScan_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → bool

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

Parameters:: request_type (LRCReqType) – Request type.
Returns:: True if allowed.
Return type:: bool

is_End_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → bool

Checks whether End command is allowed to be run in the current device state.

Parameters:: request_type (LRCReqType) – Request type.
Returns:: True if allowed.
Return type:: bool

is_Restart_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → bool

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

Returns:: True if Restart command is allowed.
Return type:: bool

is_Scan_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → bool

Checks whether Scan command is allowed to be run in the current device state.

Parameters:: request_type (LRCReqType) – Request type.
Returns:: True if allowed.
Return type:: bool

read_isAdminModeEnabled() → bool

Read method for isAdminModeEnabled attribute

Returns:: Return the isAdminModeEnabled attribute value.
Return type:: bool

read_mccsSubarrayAdminMode() → int

Read method for mccsControllerAdminMode Attribute

Returns:: Returns mccsControllerAdminMode Attribute.
Return type:: int

read_mccsSubarrayDevName() → str

Returns the mccssubarraydevname attribute.

Returns:: The MCCS Subarray device name.
Return type:: str

read_obsState() → ska_tango_base.control_model.ObsState

Read method for obsState.

Returns:: The observation state.
Return type:: ObsState

update_admin_mode_callback(admin_mode: int) → None

Update mccsSubarrayAdminMode attribute callback

Parameters:: admin_mode (int) – AdminMode for attribute callback

update_availablity_callback(availablity: bool) → None

Change event callback for isSubsystemAvailable.

Parameters:: availability (bool) – Availability for isSubsystemAvailable event callback.

update_mccs_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) → None

Change event callback for obsState.

Parameters:: obs_state (ObsState) – ObsState for obsState event callback

write_isAdminModeEnabled(value: bool) → None

Set the value of isAdminModeEnabled attribute

Parameters:: value (bool) – Value of isAdminModeEnabled to be set.

write_mccsSubarrayDevName(value: str) → None

Sets the mccssubarraydevname attribute.

Parameters:: value (str) – The new device name for the MCCS Subarray.

ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node.main(args=None, **kwargs)

Entry point for running the Tango device server.

Parameters:

args (list) – Additional arguments for the device server.
kwargs (dict) – Additional keyword arguments for the device server.

Module contents

Init module of LowTmcLeafNodeCspSubarray.

class ska_tmc_mccssubarrayleafnode.LowTmcLeafNodeMccsSubarray(*args: Any, **kwargs: Any)