MCCS Subarray Leaf Node¶
MCCS Subarray Leaf node monitors the MCCS Subarray and issues control actions during an observation. It also acts as a MCCS contact point for Subarray Node for observation execution for TMC.
-
class
tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.mccs_subarray_leaf_node.
MccsSubarrayLeafNode
(*args, **kwargs)¶ MCCS Subarray Leaf node monitors the MCCS Subarray and issues control actions during an observation.
-
Configure
(argin)¶ Invokes Configure command on MccsSubarrayLeafNode
-
class
ConfigureCommand
(*args, **kwargs)¶ A class for MccsSubarrayLeafNode’s Configure() command.
-
check_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
configure_cmd_ended_cb
(event)¶ Callback function immediately executed when the asynchronous invoked command returns.
Parameters: event – a CmdDoneEvent object. This class is used to pass data to the callback method in asynchronous callback model for command execution.
Type: CmdDoneEvent object It has the following members:
- device : (DeviceProxy) The DeviceProxy object on which the call was executed.
- cmd_name : (str) The command name
- argout_raw : (DeviceData) The command argout
- argout : The command argout
- err : (bool) A boolean flag set to true if the command failed. False otherwise
- errors : (sequence<DevError>) The error stack
- ext
Returns: none
-
do
(argin)¶ This command configures a scan. It accepts configuration information in JSON string format and invokes Configure command on MccsSubarray.
:param argin:DevString. The string in JSON format. The JSON contains following values:
Example: {“stations”:[{“station_id”:1,”tile_ids”:[1,2],},{“station_id”:2,”tile_ids”:[3,4]},],”station_beam_pointings”:[{“station_beam_id”:1,”target”:{“system”:”HORIZON”,”name”:”DriftScan”,”Az”:180.0,”El”:45.0},”update_rate”:0.0,”channels”:[1,2,3,4,5,6,7,8]}]}
Note: Enter the json string without spaces as a input.
Returns: A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type: (ReturnCode, str) Raises: DevFailed if the command execution is not successful ValueError if input argument json string contains invalid value KeyError if input argument json string contains invalid key
-
-
End
()¶ Invokes End command on MccsSubarrayLeafNode.
-
class
EndCommand
(*args, **kwargs)¶ A class for MccsSubarrayLeafNode’s End() command.
-
check_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
do
()¶ This command invokes End command on MCCS Subarray in order to end current scheduling block.
Returns: None Return type: Void Raises: DevFailed if the command execution is not successful
-
end_cmd_ended_cb
(event)¶ Callback function immediately executed when the asynchronous invoked command returns.
Parameters: event – a CmdDoneEvent object. This class is used to pass data to the callback method in asynchronous callback model for command execution.
Type: CmdDoneEvent object It has the following members:
- device : (DeviceProxy) The DeviceProxy object on which the call was executed.
- cmd_name : (str) The command name
- argout_raw : (DeviceData) The command argout
- argout : The command argout
- err : (bool) A boolean flag set to true if the command failed. False otherwise
- errors : (sequence<DevError>) The error stack
- ext
Returns: none
-
-
EndScan
()¶ Invokes EndScan command on MccsSubarray.
-
class
EndScanCommand
(*args, **kwargs)¶ A class for MccsSubarrayLeafNode’s EndScan() command.
-
check_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
do
()¶ This command invokes EndScan command on MccsSubarray. It is allowed only when MccsSubarray is in ObsState SCANNING.
Raises: DevFailed if the command execution is not successful. AssertionError if MccsSubarray is not in SCANNING obsState.
-
endscan_cmd_ended_cb
(event)¶ Callback function immediately executed when the asynchronous invoked command returns.
Parameters: event – a CmdDoneEvent object. This class is used to pass data to the callback method in asynchronous callback model for command execution.
Type: CmdDoneEvent object It has the following members:
- device : (DeviceProxy) The DeviceProxy object on which the call was executed.
- cmd_name : (str) The command name
- argout_raw : (DeviceData) The command argout
- argout : The command argout
- err : (bool) A boolean flag set to true if the command failed. False otherwise
- errors : (sequence<DevError>) The error stack
- ext
Returns: none
-
-
class
InitCommand
(*args, **kwargs)¶ A class for the MccsSubarrayLeafNode’s init_device() method”
-
do
()¶ Initializes the attributes and properties of the MccsSubarrayLeafNode.
Returns: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type: (ReturnCode, str) Raises: DevFailed if error occurs in creating proxy for MCCSSubarray.
-
-
MccsSubarrayFQDN
¶ Used by autodoc_mock_imports.
-
Scan
(argin)¶ Invokes Scan command on mccssubarrayleafnode
-
class
ScanCommand
(*args, **kwargs)¶ A class for MccsSubarrayLeafNode’s Scan() command.
-
check_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
do
(argin)¶ This command invokes Scan command on MccsSubarray. It is allowed only when MccsSubarray is in ObsState READY.
Parameters: argin – JSON string consists of scan id (int). Example: {“id”:1}
Note: Enter the json string without spaces as a input.
Returns: None Return type: Void Raises: DevFailed if the command execution is not successful
-
scan_cmd_ended_cb
(event)¶ Callback function immediately executed when the asynchronous invoked command returns.
Parameters: event – a CmdDoneEvent object. This class is used to pass data to the callback method in asynchronous callback model for command execution.
Type: CmdDoneEvent object It has the following members:
- device : (DeviceProxy) The DeviceProxy object on which the call was executed.
- cmd_name : (str) The command name
- argout_raw : (DeviceData) The command argout
- argout : The command argout
- err : (bool) A boolean flag set to true if the command failed. False otherwise
- errors : (sequence<DevError>) The error stack
- ext
Returns: none
-
-
activityMessage
¶ Used by autodoc_mock_imports.
-
always_executed_hook
()¶ Internal construct of TANGO.
-
delete_device
()¶ Internal construct of TANGO.
-
init_command_objects
()¶ Initialises the command handlers for commands supported by this device.
-
is_Configure_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state
Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
is_EndScan_allowed
()¶ Checks whether the command is allowed to be run in the current state.
Returns: True if this command is allowed to be run in current device state
Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
is_End_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state
Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
is_Scan_allowed
()¶ Checks whether the command is allowed to be run in the current state
Returns: True if this command is allowed to be run in current device state
Return type: boolean Raises: DevFailed if this command is not allowed to be run in current device state
-
mccsSubarrayObsState
¶ Used by autodoc_mock_imports.
-
mccssubarrayHealthState
¶ Used by autodoc_mock_imports.
-
read_activityMessage
()¶
-
write_activityMessage
(value)¶
-
-
tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.mccs_subarray_leaf_node.
main
(args=None, **kwargs)¶