ska_tmc_cspmasterleafnode.manager package
Submodules
ska_tmc_cspmasterleafnode.manager.component_manager module
This module implements ComponentManager class for the CSP Master Leaf Node.
- class ska_tmc_cspmasterleafnode.manager.component_manager.CspMLNComponentManager(*args: Any, **kwargs: Any)
Bases:
TmcLeafNodeComponentManagerA component manager for The CSP Master Leaf Node component.
It supports in controlling the behaviour of CSP Master.
- property csp_master_device_name: str
Returns device name for the CSP Master Device.
- device_failed(device_info, exception)
Set a device to failed and call the relative callback if available :param device_info: a device info :type device_info: DeviceInfo :param exception: an exception :type: Exception
- is_command_allowed(command_name: str) bool
Checks whether this command is allowed. It checks that the device is in the right state to execute this command and that all the components needed for the operation are not unresponsive.
- Returns:
True if this command is allowed
- Return type:
boolean
- off_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the Off command for execution.
- Return type:
tuple
- on_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the On command for execution.
- Return type:
tuple
- standby_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the Standby command for execution.
- Return type:
tuple
- update_ping_info(ping: int, dev_name: str) None
Update a device with the correct ping information.
- Parameters:
dev_name (str) – name of the device
ping (int) – device response time
Module contents
Init file for CSP Master Leaf Node Manager
- class ska_tmc_cspmasterleafnode.manager.CspMLNComponentManager(*args: Any, **kwargs: Any)
Bases:
TmcLeafNodeComponentManagerA component manager for The CSP Master Leaf Node component.
It supports in controlling the behaviour of CSP Master.
- property csp_master_device_name: str
Returns device name for the CSP Master Device.
- device_failed(device_info, exception)
Set a device to failed and call the relative callback if available :param device_info: a device info :type device_info: DeviceInfo :param exception: an exception :type: Exception
- is_command_allowed(command_name: str) bool
Checks whether this command is allowed. It checks that the device is in the right state to execute this command and that all the components needed for the operation are not unresponsive.
- Returns:
True if this command is allowed
- Return type:
boolean
- off_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the Off command for execution.
- Return type:
tuple
- on_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the On command for execution.
- Return type:
tuple
- standby_command(task_callback=None) Tuple[ska_tango_base.executor.TaskStatus, str]
Submits the Standby command for execution.
- Return type:
tuple
- update_ping_info(ping: int, dev_name: str) None
Update a device with the correct ping information.
- Parameters:
dev_name (str) – name of the device
ping (int) – device response time