Observing Component

class ska_csp_lmc_common.observing_component.ObservingComponent(fqdn: str, name: str, weight: int = 0, logger: Logger | None = None)

Bases: Component

Class to model a CSP subordinate observing device.

property capability_id: int

Return the capability device identification number.

Returns:

The capability device ID.

property obs_state: ska_control_model.ObsState

Return the CSP Subarray sub-system obs_state.

Returns:

the sub-system obsState if updated via events or via direct read, EMPTY on failure

set_tmp_command_name(value: str)

Set a temporary variable to modify the name of the command. It is needed since different version of base classes have different command name (from low cbf (> 0.6.1))

Parameters:

value – the value of the command name that have to be sent to the subarray

Returns:

None

set_component_disconnected()

This method is called when the CSP TANGO Device adminMode is set to OFFLINE.

In this case the CSP Device componentManager does no longer monitor the component and its information are reported as unknown. The component admin mode is not changed.

set_component_unknown(admin_mode_value: ska_control_model.AdminMode) → None

Specialized version for observing sub-system components.

Parameters:

admin_mode_value – the value of the CSP sub-system device adminMode.

Returns:

None

set_component_offline(admin_mode_value: ska_control_model.AdminMode) → None

Specialized version for observing sub-system components.

Parameters:

admin_mode_value – the value of the CSP sub-system device adminMode.

configure(resources_dict: Dict, callback: Callable | None = None) → None

Run the command configure scan on the component.

Raise:

a ValueError exception if the component is not in the proper state to run the command

gotoidle(callback: Callable | None = None) → None

Run the command gotoidle on the component.

Raise:

a ValueError exception if the component is not in the proper state to run the command

assignresources(resources_dict: Dict, callback: Callable | None = None) → None

Run the command assignresources on the component.

Raise:

a ValueError exception if the component is not in the proper state to run the command

releaseresources(resources_dict: Dict, callback: Callable | None = None) → None

Run the command releaseresources on the component.

Method to specialize into the specific component, if needed.

Raise:

a ValueError exception if the component is not in the proper state to run the command

releaseallresources(callback: Callable | None = None) → None

Run the command releaseallresources on the component.

Method to specialize into the specific component, if needed.

Raise:

a ValueError exception if the component is not in the proper state to run the command