ska_tmc_mccssubarrayleafnode package
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.MccsSubarrayLeafNode(*args: Any, **kwargs: Any)
Bases:
TMCBaseLeafDeviceMCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray.
- class InitCommand(*args: Any, **kwargs: Any)
Bases:
InitCommandA class for the TMC MccsSubarrayLeafNode’s init_device() method.
- do(*args, **kwargs) Tuple[ska_tango_base.commands.ResultCode, str]
Initializes the attributes and properties of the MccsSubarrayLeafNode.
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purposes only.
- Return type:
(ResultCode, str)
- always_executed_hook() None
- create_component_manager()
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_command_objects() None
Initialises the command handlers for commands supported by this device.
- 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() bool
Checks whether Configure command is allowed to be run in the current device state.
- Returns:
True if Configure command is allowed.
- Return type:
bool
- is_EndScan_allowed() bool
Checks whether EndScan command is allowed to be run in current device state.
- Returns:
True if EndScan command is allowed to be run in current device state.
- rtype:
boolean
- is_End_allowed() bool
- Checks whether End command is allowed to be run in the current device
state.
- Returns:
True if End command is allowed.
- Return type:
bool
- is_Restart_allowed() 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() bool
- Checks whether Scan command is allowed to be run in the current device
state.
- Returns:
True if Scan command is allowed.
- Return type:
bool
- read_isSubsystemAvailable() bool
Returns the isSubsystemAvailable attribute.
- Returns:
The availability status of the subsystem.
- Return type:
bool
- 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_availablity_callback(availablity: bool) None
Change event callback for isSubsystemAvailable.
- update_mccs_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) None
Change event callback for obsState.
- 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 MccsSubarrayLeafNode.
- class ska_tmc_mccssubarrayleafnode.MccsSubarrayLeafNode(*args: Any, **kwargs: Any)
Bases:
TMCBaseLeafDeviceMCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray.
- class InitCommand(*args: Any, **kwargs: Any)
Bases:
InitCommandA class for the TMC MccsSubarrayLeafNode’s init_device() method.
- do(*args, **kwargs) Tuple[ska_tango_base.commands.ResultCode, str]
Initializes the attributes and properties of the MccsSubarrayLeafNode.
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purposes only.
- Return type:
(ResultCode, str)
- always_executed_hook() None
- create_component_manager()
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_command_objects() None
Initialises the command handlers for commands supported by this device.
- 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() bool
Checks whether Configure command is allowed to be run in the current device state.
- Returns:
True if Configure command is allowed.
- Return type:
bool
- is_EndScan_allowed() bool
Checks whether EndScan command is allowed to be run in current device state.
- Returns:
True if EndScan command is allowed to be run in current device state.
- rtype:
boolean
- is_End_allowed() bool
- Checks whether End command is allowed to be run in the current device
state.
- Returns:
True if End command is allowed.
- Return type:
bool
- is_Restart_allowed() 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() bool
- Checks whether Scan command is allowed to be run in the current device
state.
- Returns:
True if Scan command is allowed.
- Return type:
bool
- read_isSubsystemAvailable() bool
Returns the isSubsystemAvailable attribute.
- Returns:
The availability status of the subsystem.
- Return type:
bool
- 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_availablity_callback(availablity: bool) None
Change event callback for isSubsystemAvailable.
- update_mccs_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) None
Change event callback for obsState.
- write_mccsSubarrayDevName(value: str) None
Sets the mccssubarraydevname attribute.
- Parameters:
value (str) – The new device name for the MCCS Subarray.