ska_tmc_subarraynode.subarray_node module
Subarray Node Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.
- class ska_tmc_subarraynode.subarray_node.BaseSubarrayNode(*args, **kwargs)
Bases:
SKASubarray,TMCBaseDeviceProvides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.
BaseSubarrayNode class is inherited from SKASubarray class and TMCBaseDevice class. TMCBaseDevice class is further inherited from SKABaseDevice class.
Common attributes and device_properties within TMC nodes are getting inherited from TMCBaseDevice.
- Device Properties
- SdpSubarrayLNFQDN:
This property contains the FQDN of the SDP Subarray Leaf Node associated with the Subarray Node.
- CspSubarrayLNFQDN:
This property contains the FQDN of the CSP Subarray Leaf Node associated with the Subarray Node.
- CspSubarrayFQDN:
FQDN of the CSP Subarray Tango Device Server.
- SdpSubarrayFQDN:
FQDN of the SDP Subarray Tango Device Server.
- Device Attributes
- scanID:
ID of ongoing SCAN
- sbID:
ID of ongoing Scheduling Block
- isSubarrayAvailable:
Shows availability of subarray device
- InitCommand = None
- create_component_manager()
Create component manager object for command invocation.
- Return type
- internalModel_read()
Internal construct of TANGO. Returns the internal model.
- Returns
JSON-encoded string with the internal model
- Return type
- is_Abort_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command Abort is allowed in the current device state.
- Returns
Trueif the command is allowed
- is_AssignResources_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Return whether the AssignResource command may be called in the current state.
- Returns
whether the command may be called in the current observational state
- Return type
- is_Configure_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command Configure is allowed in the current device state.
- is_EndScan_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command EndScan is allowed in the current device state.
- is_End_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command End is allowed in the current device state.
- is_Off_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Checks whether the command is allowed to be run in the current state
- Return type
- Returns
True if this command is allowed to be run in current device state, False otherwise.
- Raises:DevFailed if this command is not allowed to be run
in current device state
- is_On_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Checks whether the command is allowed to be run in the current state
- Returns
Trueif this command is allowed to be run in current device state, False otherwise.- Return type
- Raises
DevFailed if this command is not allowed to be run in current device state
- is_ReleaseAllResources_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command ReleaseAllResources is allowed in the current device state.
- is_Restart_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command Restart is allowed in the current device state.
- is_Scan_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command Scan is allowed in the current device state.
- is_SetAdminMode_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Check if command Restart is allowed in the current device state.
- is_Standby_allowed(request_type=ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)
Checks whether the command Standby is allowed to be run in the current state
- Return type
- Returns
True if this command is allowed to be run in current device state, False otherwise.
- Raises:DevFailed if this command is not allowed to be run
in current device state
- read_isAdminModeEnabled()
Return the isAdminModeEnabled attribute value
- Returns
True if the admin mode is enabled, False otherwise
- Return type
- read_sbID()
Internal construct of TANGO. Returns the scheduling block ID.
- Returns
string with the scheduling block ID
- Return type
- read_scanID()
Internal construct of TANGO. Returns the Scan ID.
- EXAMPLE: 123
Where 123 is a Scan ID from configuration json string.
- Returns
string with the scan ID
- Return type
- scanDuration()
This attribute is used for exposing the scan duration of ongoing scan to other subsystems.
- Returns
The scan duration of the ongoing scan
- Return type
- transformedInternalModel_read()
Internal construct of TANGO. Returns the transformed internal model.
- Returns
JSON-encoded string with the transformed internal model
- Return type
- update_assigned_resources_callback(assigned_resources)
Triggers a push change event for the assigned resources.
- update_device_callback(dev_info)
Updates the last device information changed and triggers a push change event.
- Parameters
dev_info (DeviceInfo) – The device information to update.
- Return type
- update_scan_duration_callback(scan_duration)
Triggers a push change event for the change in scan duration.
- update_subarray_availability_status_callback(subarray_availability)
Triggers a push change event for the isSubarrayAvailable.
- update_subarray_health_info_callback(subarray_health_info)
This method updates the subarray health info and triggers a push change event.
- Parameters
subarray_health_info – Aggregated health info for the subarray
- Return type
- update_subarray_health_state_callback(subarray_health_state)
This method updates the subarray health state and triggers a push change event.
- write_arrayLayoutUrl(uri)
Set the Array Layout URL value.
- write_isAdminModeEnabled(value)
Set the value of isAdminModeEnabled attribute