CbfSubarray Component Class

class ska_mid_cbf_mcs.subarray.subarray_component_manager.CbfSubarrayComponentManager(*args: Any, **kwargs: Any)[source]

Bases: CbfComponentManager, CspSubarrayComponentManager

A component manager for the CbfSubarray class.

property config_id: str: Return the configuration ID.

property scan_id: int: Return the scan ID.

property subarray_id: int: Return the subarray ID.

property frequency_band: int: Return the frequency band.

property receptors: List[str]: Return the receptor list.

start_communicating() → None[source]: Establish communication with the component, then start monitoring.

stop_communicating() → None[source]: Stop communication with the component.

on() → None[source]: Turn the component on.

off() → None[source]: Turn the component off.

standby() → None[source]: Put the component into low-power standby mode.

update_sys_param(sys_param_str: str) → None[source]

validate_ip(ip: str) → bool[source]

Validate IP address format.

Parameters:: ip – IP address to be evaluated
Returns:: whether or not the IP address format is valid
Return type:: bool

raise_configure_scan_fatal_error(msg: str) → Tuple[ResultCode, str][source]

Raise fatal error in ConfigureScan execution

Parameters:: msg – error message
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

raise_update_delay_model_fatal_error(msg: str) → Tuple[ResultCode, str][source]

Raise fatal error in UpdateDelayModel execution

Parameters:: msg – error message
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

deconfigure() → None[source]: Completely deconfigure the subarray; all initialization performed by by the ConfigureScan command must be ‘undone’ here.

validate_input(argin: str) → Tuple[bool, str][source]

Validate scan configuration.

Parameters:: argin – The configuration as JSON formatted string.
Returns:: A tuple containing a boolean indicating if the configuration is valid and a string message. The message is for information purpose only.
Return type:: (bool, str)

configure_scan(argin: str) → Tuple[ResultCode, str][source]

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

remove_receptors(argin: List[str]) → Tuple[ResultCode, str][source]

Remove receptor from subarray.

Parameters:: argin – The receptors to be released
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

remove_all_receptors() → Tuple[ResultCode, str][source]

Remove all receptors from subarray.

Parameters:: receptor_id – The receptor to be released
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

add_receptors(argin: List[str]) → Tuple[ResultCode, str][source]

Add receptors to subarray.

Parameters:: argin – The receptors to be assigned
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

scan(argin: Dict[Any]) → Tuple[ResultCode, str][source]

Start subarray Scan operation.

Parameters:: argin (str) – The scan ID as JSON formatted string.
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

end_scan() → Tuple[ResultCode, str][source]

End subarray Scan operation.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

abort() → None[source]: Abort subarray configuration or operation.

restart() → None[source]: Restart to EMPTY from abort/fault.

obsreset() → None[source]: Reset to IDLE from abort/fault.

update_component_resources(resourced: bool) → None[source]

Update the component resource status, calling callbacks as required.

Parameters:: resourced – whether the component is resourced.

update_component_configuration(configured: bool) → None[source]

Update the component configuration status, calling callbacks as required.

Parameters:: configured – whether the component is configured.