ska_tmc_subarraynode package

Subpackages

• ska_tmc_subarraynode.commands package
• Submodules
  • abstract_command
  • assign_resources_command
    • AssignResources
      • AssignResources.assign_csp_resources()
      • AssignResources.assign_low_csp_resources()
      • AssignResources.assign_sdp_resources()
      • AssignResources.clear_resources()
      • AssignResources.do_low()
      • AssignResources.do_mid()
      • AssignResources.invoke_assign_resources()
      • AssignResources.set_up_dish_data()
      • AssignResources.update_task_status()
      • AssignResources.validate_low_json()
  • configure_command
    • Configure
      • Configure.check_only_dish_config()
      • Configure.configure_low_csp()
      • Configure.do_low()
      • Configure.do_mid()
      • Configure.invoke_configure()
      • Configure.update_task_status()
    • ElementDeviceData
      • ElementDeviceData.build_up_csp_cmd_data()
      • ElementDeviceData.build_up_dsh_cmd_data()
      • ElementDeviceData.build_up_sdp_cmd_data()
  • end_command
    • End
      • End.do_low()
      • End.do_mid()
      • End.end_csp()
      • End.end_mccs()
      • End.end_sdp()
      • End.invoke_end()
      • End.stop_dish_tracking()
      • End.update_task_status()
  • end_scan_command
    • EndScan
      • EndScan.do_low()
      • EndScan.do_mid()
      • EndScan.end_scan()
      • EndScan.end_scan_low()
      • EndScan.end_scan_mccs()
      • EndScan.end_scan_mid()
      • EndScan.endscan_csp()
      • EndScan.endscan_sdp()
      • EndScan.invoke_end_scan()
      • EndScan.update_task_status()
  • obsreset_command
    • ObsReset
      • ObsReset.do()
      • ObsReset.do_low()
      • ObsReset.do_mid()
      • ObsReset.get_csp_subarray_obsstate()
      • ObsReset.get_sdp_subarray_obsstate()
      • ObsReset.is_allowed()
      • ObsReset.is_allowed_low()
      • ObsReset.is_allowed_mid()
      • ObsReset.obsreset_csp()
      • ObsReset.obsreset_sdp()
      • ObsReset.obsrest_dish()
  • release_all_resources_command
    • ReleaseAllResources
      • ReleaseAllResources.clean_up_low_resources()
      • ReleaseAllResources.clean_up_mid_resources()
      • ReleaseAllResources.do_low()
      • ReleaseAllResources.do_mid()
      • ReleaseAllResources.invoke_release_resources()
      • ReleaseAllResources.release_csp_resources()
      • ReleaseAllResources.release_sdp_resources()
      • ReleaseAllResources.update_task_status()
  • restart_command
    • Restart
      • Restart.clean_up_configuration()
      • Restart.clean_up_dishes()
      • Restart.do_low()
      • Restart.do_mid()
      • Restart.invoke_restart()
      • Restart.restart_csp()
      • Restart.restart_dishes()
      • Restart.restart_mccs()
      • Restart.restart_sdp()
  • scan_command
    • Scan
      • Scan.do_low()
      • Scan.do_mid()
      • Scan.invoke_scan()
      • Scan.scan_csp()
      • Scan.scan_csp_low()
      • Scan.scan_mccs()
      • Scan.scan_sdp()
      • Scan.start_scan_timer()
      • Scan.update_mccs_json()
      • Scan.update_task_status()
  • off_command
    • Off
      • Off.do_low()
      • Off.do_mid()
      • Off.get_csp_subarray_obstate()
      • Off.get_sdp_subarray_obstate()
      • Off.get_subarray_obstate()
      • Off.subarray_off()
      • Off.update_task_status()
  • on_command
    • On
      • On.do_low()
      • On.do_mid()
      • On.on_leaf_nodes()
  • Module contents
• ska_tmc_subarraynode.manager package
• Submodules
  • aggregators
    • HealthStateAggregatorLow
      • HealthStateAggregatorLow.aggregate()
    • HealthStateAggregatorMid
      • HealthStateAggregatorMid.aggregate()
    • ObsStateAggregatorLow
      • ObsStateAggregatorLow.aggregate()
      • ObsStateAggregatorLow.subarray_node_obstate_not_aggregated()
    • ObsStateAggregatorMid
      • ObsStateAggregatorMid.aggregate()
      • ObsStateAggregatorMid.subarray_node_obstate_not_aggregated()
    • SubarrayAvailabilityAggregatorLow
      • SubarrayAvailabilityAggregatorLow.aggregate()
    • SubarrayAvailabilityAggregatorMid
      • SubarrayAvailabilityAggregatorMid.aggregate()
  • event_receiver
    • SubarrayNodeEventReceiver
      • SubarrayNodeEventReceiver.check_event_error()
      • SubarrayNodeEventReceiver.handle_assigned_resources_event()
      • SubarrayNodeEventReceiver.handle_csp_leaf_obs_state_event()
      • SubarrayNodeEventReceiver.handle_dish_mode_event()
      • SubarrayNodeEventReceiver.handle_lrcr_event()
      • SubarrayNodeEventReceiver.handle_mccs_leaf_obs_state_event()
      • SubarrayNodeEventReceiver.handle_pointing_state_event()
      • SubarrayNodeEventReceiver.handle_receive_addresses_event()
      • SubarrayNodeEventReceiver.handle_sdp_leaf_obs_state_event()
      • SubarrayNodeEventReceiver.handle_subsystem_availability_event()
      • SubarrayNodeEventReceiver.subscribe_events()
      • SubarrayNodeEventReceiver.unscubscribe_dish_health()
      • SubarrayNodeEventReceiver.unscubscribe_dish_leaf_health()
      • SubarrayNodeEventReceiver.unscubscribe_dish_leaf_state()
      • SubarrayNodeEventReceiver.unscubscribe_dish_mode()
      • SubarrayNodeEventReceiver.unscubscribe_dish_pointing()
      • SubarrayNodeEventReceiver.unscubscribe_dish_state()
      • SubarrayNodeEventReceiver.unsubscribe_dish_events()
      • SubarrayNodeEventReceiver.unsubscribe_dish_leaf_events()
  • subarray_node_component_manager
    • SubarrayNodeComponentManager
      • SubarrayNodeComponentManager.abort()
      • SubarrayNodeComponentManager.add_device_to_lp()
      • SubarrayNodeComponentManager.add_multiple_devices()
      • SubarrayNodeComponentManager.add_similar_low_mid_device()
      • SubarrayNodeComponentManager.assign()
      • SubarrayNodeComponentManager.assigned_resources
      • SubarrayNodeComponentManager.check_command_not_allowed_exception()
      • SubarrayNodeComponentManager.check_for_incremental_assign_and_revise_obsstate()
      • SubarrayNodeComponentManager.check_if_no_dishes_available()
      • SubarrayNodeComponentManager.check_if_sdp_sln_is_available()
      • SubarrayNodeComponentManager.check_subarray_device_availability()
      • SubarrayNodeComponentManager.checked_devices
      • SubarrayNodeComponentManager.clear_assigned_resources()
      • SubarrayNodeComponentManager.command_in_progress
      • SubarrayNodeComponentManager.component_state_changed_callback_and_logging()
      • SubarrayNodeComponentManager.configure()
      • SubarrayNodeComponentManager.device_failed()
      • SubarrayNodeComponentManager.devices
      • SubarrayNodeComponentManager.end()
      • SubarrayNodeComponentManager.end_scan()
      • SubarrayNodeComponentManager.generate_command_result()
      • SubarrayNodeComponentManager.get_assigned_resources()
      • SubarrayNodeComponentManager.get_csp_subarray_dev_name()
      • SubarrayNodeComponentManager.get_device_info_by_name()
      • SubarrayNodeComponentManager.get_mccs_subarray_dev_name()
      • SubarrayNodeComponentManager.get_sb_id()
      • SubarrayNodeComponentManager.get_scan_duration()
      • SubarrayNodeComponentManager.get_scan_id()
      • SubarrayNodeComponentManager.get_sdp_subarray_dev_name()
      • SubarrayNodeComponentManager.get_subarray_availability()
      • SubarrayNodeComponentManager.get_subarray_healthstate()
      • SubarrayNodeComponentManager.get_subarray_id()
      • SubarrayNodeComponentManager.get_subarray_obsstate()
      • SubarrayNodeComponentManager.get_tmc_csp_sln_device_name()
      • SubarrayNodeComponentManager.get_tmc_mccs_sln_device_name()
      • SubarrayNodeComponentManager.get_tmc_sdp_sln_device_name()
      • SubarrayNodeComponentManager.input_parameter
      • SubarrayNodeComponentManager.is_command_allowed()
      • SubarrayNodeComponentManager.is_partial_configuration
      • SubarrayNodeComponentManager.is_scan_timer_running()
      • SubarrayNodeComponentManager.off()
      • SubarrayNodeComponentManager.on()
      • SubarrayNodeComponentManager.release_all()
      • SubarrayNodeComponentManager.reset()
      • SubarrayNodeComponentManager.reset_sb_id()
      • SubarrayNodeComponentManager.reset_scan_duration()
      • SubarrayNodeComponentManager.reset_sdp_csp_event_count()
      • SubarrayNodeComponentManager.reset_subarray_id()
      • SubarrayNodeComponentManager.restart()
      • SubarrayNodeComponentManager.scan()
      • SubarrayNodeComponentManager.set_assigned_resources()
      • SubarrayNodeComponentManager.set_sb_id()
      • SubarrayNodeComponentManager.set_scan_duration()
      • SubarrayNodeComponentManager.set_scan_id()
      • SubarrayNodeComponentManager.set_subarray_id()
      • SubarrayNodeComponentManager.stop()
      • SubarrayNodeComponentManager.stop_event_receiver()
      • SubarrayNodeComponentManager.stop_liveliness_probe()
      • SubarrayNodeComponentManager.stop_scan_timer()
      • SubarrayNodeComponentManager.subarray_availability_check()
      • SubarrayNodeComponentManager.subarray_obsstate
      • SubarrayNodeComponentManager.unsubscribe_dish_events()
      • SubarrayNodeComponentManager.update_assigned_resources()
      • SubarrayNodeComponentManager.update_device_dish_mode()
      • SubarrayNodeComponentManager.update_device_health_state()
      • SubarrayNodeComponentManager.update_device_obs_state()
      • SubarrayNodeComponentManager.update_device_pointing_state()
      • SubarrayNodeComponentManager.update_device_state()
      • SubarrayNodeComponentManager.update_event_failure()
      • SubarrayNodeComponentManager.update_input_parameter()
      • SubarrayNodeComponentManager.update_long_running_command_result()
      • SubarrayNodeComponentManager.update_ping_info()
      • SubarrayNodeComponentManager.update_receive_addresses()
      • SubarrayNodeComponentManager.update_subarray_availability_status()
      • SubarrayNodeComponentManager.update_subarray_node_obsstate()
      • SubarrayNodeComponentManager.validate_scan_low_json()
  • Module contents
• ska_tmc_subarraynode.model package
• Submodules
  • component module
    • SubarrayComponent
      • SubarrayComponent.assigned_resources
      • SubarrayComponent.devices
      • SubarrayComponent.get_device()
      • SubarrayComponent.invoke_device_callback()
      • SubarrayComponent.remove_device()
      • SubarrayComponent.sb_id
      • SubarrayComponent.scan_duration
      • SubarrayComponent.scan_id
      • SubarrayComponent.set_obs_callbacks()
      • SubarrayComponent.set_op_callbacks()
      • SubarrayComponent.subarray_availability
      • SubarrayComponent.subarray_health_state
      • SubarrayComponent.subarray_id
      • SubarrayComponent.to_dict()
      • SubarrayComponent.update_device()
      • SubarrayComponent.update_device_exception()
  • enum module
    • PointingState
      • PointingState.NONE
      • PointingState.READY
      • PointingState.SCAN
      • PointingState.SLEW
      • PointingState.TRACK
      • PointingState.UNKNOWN
  • input module
    • InputParameter
      • InputParameter.csp_subarray_dev_name
      • InputParameter.sdp_subarray_dev_name
      • InputParameter.tmc_csp_sln_device_name
      • InputParameter.tmc_sdp_sln_device_name
      • InputParameter.update()
    • InputParameterLow
      • InputParameterLow.mccs_subarray_dev_name
      • InputParameterLow.tmc_mccs_sln_device_name
      • InputParameterLow.update()
    • InputParameterMid
      • InputParameterMid.dish_dev_names
      • InputParameterMid.tmc_dish_ln_device_names
      • InputParameterMid.update()
  • Module contents

Submodules

subarraynode_node

Path: src/ska_tmc_subarraynode/subarray_node.py

subarraynode_node_low

Path: src/ska_tmc_subarraynode/subarray_node_low.py

subarraynode_node_mid

Path: src/ska_tmc_subarraynode/subarray_node_mid.py

exceptions

Path: src/ska_tmc_subarraynode/exceptions.py

This module has custom exception for repository ska_tmc_subarraynode

exception ska_tmc_subarraynode.exceptions.CommandNotAllowed

Bases: Exception

Raised when a command is not allowed.

exception ska_tmc_subarraynode.exceptions.DeviceUnresponsive

Bases: Exception

Raised when a device is not responsive.

exception ska_tmc_subarraynode.exceptions.InvalidObsStateError

Bases: ValueError

Raised when subarray is not in required obsState.

release

Path: src/ska_tmc_subarraynode/release.py

Release information for Python Package

transaction_id

Path: src/ska_tmc_subarraynode/transaction_id.py

This module is for identifing and changing the transaction ids

ska_tmc_subarraynode.transaction_id.identify_with_id(name, arg_name)

This method decorator that identifies a transaction with a unique ID and adds it to the wrapped function’s object.

ska_tmc_subarraynode.transaction_id.inject_id(obj, data)

This method injecting a transaction id

Return type

Dict

ska_tmc_subarraynode.transaction_id.inject_with_id(arg_position, arg_name)

For this method A decorator that injects an ID field into a dictionary-like argument of a function.

ska_tmc_subarraynode.transaction_id.update_with_id(obj, parameters)

Updates the given dictionary-like obj with an ID field and the values in parameters.

Return type

Union[Dict, str]

Module contents