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: TmcLeafNodeComponentManager

A component manager for The CSP Master Leaf Node component.

It supports in controlling the behaviour of CSP Master.

check_if_csp_master_is_responsive() → None

Checks if Csp Master device is responsive.

property csp_master_device_name: str

Returns device name for the CSP Master Device.

get_device() → ska_tmc_common.DeviceInfo

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(task_callback)

Empty method for resolving lint issue

off_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the Off command for execution.

Return type:

tuple

on(task_callback)

Empty method for resolving lint issue

on_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the On command for execution.

Return type:

tuple

standby(task_callback)

Empty method for resolving lint issue

standby_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the Standby command for execution.

Return type:

tuple

start_communicating()

Empty method for resolving lint issue

stop_communicating()

Empty method for resolving lint issue

update_device_ping_failure(device_info: ska_tmc_common.DeviceInfo, exception: str)

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

update_ping_info(ping: int, device_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: TmcLeafNodeComponentManager

A component manager for The CSP Master Leaf Node component.

It supports in controlling the behaviour of CSP Master.

check_if_csp_master_is_responsive() → None

Checks if Csp Master device is responsive.

property csp_master_device_name: str

Returns device name for the CSP Master Device.

get_device() → ska_tmc_common.DeviceInfo

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(task_callback)

Empty method for resolving lint issue

off_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the Off command for execution.

Return type:

tuple

on(task_callback)

Empty method for resolving lint issue

on_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the On command for execution.

Return type:

tuple

standby(task_callback)

Empty method for resolving lint issue

standby_command(task_callback: ska_tango_base.base.TaskCallbackType) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the Standby command for execution.

Return type:

tuple

start_communicating()

Empty method for resolving lint issue

stop_communicating()

Empty method for resolving lint issue

update_device_ping_failure(device_info: ska_tmc_common.DeviceInfo, exception: str)

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

update_ping_info(ping: int, device_name: str) → None

Update a device with the correct ping information.

Parameters:

• dev_name (str) – name of the device

• ping (int) – device response time

class ska_tmc_cspmasterleafnode.manager.CspMLNComponentManagerMid(*args: Any, **kwargs: Any)

Bases: CspMLNComponentManager

A component manager for The CSP Master Leaf Node Mid component.

clear_load_dish_cfg_attributes()

Clear all load dish cfg attribute after command completes

get_load_dish_cfg_result() → None

Return Load Dish Cfg command result

handle_dish_vcc_config_callback(event) → None

Handle dish vcc config attribute change event

handle_long_running_command_result_callback(event) → None

Event for LongRunning Command Result

handle_source_dish_vcc_config_callback(event) → None

Handle source dish vcc config attribute change event

is_dish_vcc_config_valid() → Tuple[bool, str]

Validate the sent dish vcc config and source dish vcc config match with received dish vcc config and source dish vcc config

is_event_failed(event) → bool

Check if event failed

load_dish_cfg_command(argin: str, task_callback=None) → Tuple[ska_tango_base.executor.TaskStatus, str]

Submits the LoadDishCfg command for execution. :rtype: tuple

start_dish_vcc_validation() → None

Create Dish Vcc validation manager object and call validate method

update_command_result(dev_name: str, value: Tuple[str, str]) → None

Updates the long running command result callback

update_dish_vcc_map_validation_result(value: ska_tango_base.commands.ResultCode) → None

Update dish vcc map validation result :param value: ResultCode value to be updated :param type: ResultCode Enum