SDP Subarray Leaf Node

class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.sdp_subarray_leaf_node.SdpSubarrayLeafNode(*args, **kwargs)

SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation.

Device Properties

SdpSubarrayFQDN:
 FQDN of the SDP Subarray Tango Device Server.

Device Attributes

ReceiveAddresses:
 This attribute is used for testing purposes. In the unit test cases it is used to provide FQDN of receiveAddresses attribute from SDP.
ActivityMessage:
 String providing information about the current activity in SDPLeafNode.
ActiveProcessingBlocks:
 This is a attribute from SDP Subarray which depicts the active Processing Blocks in the SDP Subarray.
SdpSubarrayHealthState:
 Attribute to provide SDP Subarray Health State.
SdpSubarrayObsState:
 Attribute to show ObsState of Tango Device.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.abort_command.Abort(*args, **kwargs)

A class for sdpSubarrayLeafNode’s Abort() command.

Command to abort the current operation being done on the SDP subarray.

do()

Method to invoke Abort command on SDP Subarray.

Returns:None
Raises:DevFailed if error occurs while invoking command on CSPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.assign_resources_command.AssignResources(*args, **kwargs)

A class for SdpSubarayLeafNode’s AssignResources() command.

Assigns resources to given SDP subarray. This command is provided as a noop placeholder from SDP subarray. Eventually this will likely take a JSON string specifying the resource request.

do(argin)

Method to invoke AssignResources command on SDP SUbarray.

Parameters:argin – The string in JSON format. The JSON contains following values:
SBI ID and maximum length of the SBI:

Mandatory JSON object consisting of

SBI ID :
String
max_length:
Float
Scan types:

Consist of Scan type id name

scan_type:
DevVarStringArray
Processing blocks:

Mandatory JSON object consisting of

processing_blocks:
DevVarStringArray
Example:
{“id”:”sbi-mvp01-20200325-00001”,”max_length”:100.0,”scan_types”:[{“id”:”science_A”, “coordinate_system”:”ICRS”,”ra”:”02:42:40.771”,”dec”:”-00:00:47.84”,”channels”:[{“count” :744,”start”:0,”stride”:2,”freq_min”:0.35e9,”freq_max”:0.368e9,”link_map”:[[0,0],[200,1], [744,2],[944,3]]},{“count”:744,”start”:2000,”stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9, “link_map”:[[2000,4],[2200,5]]}]},{“id”:”calibration_B”,”coordinate_system”:”ICRS”,”ra”: “12:29:06.699”,”dec”:”02:03:08.598”,”channels”:[{“count”:744,”start”:0,”stride”:2, “freq_min”:0.35e9,”freq_max”:0.368e9,”link_map”:[[0,0],[200,1],[744,2],[944,3]]},{“count”:744, “start”:2000,”stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9,”link_map”:[[2000,4],[2200,5]]}]}] ,”processing_blocks”:[{“id”:”pb-mvp01-20200325-00001”,”workflow”:{“type”:”realtime”,”id”: “vis_receive”,”version”:”0.1.0”},”parameters”:{}},{“id”:”pb-mvp01-20200325-00002”,”workflow”: {“type”:”realtime”,”id”:”test_realtime”,”version”:”0.1.0”},”parameters”:{}},{“id”: “pb-mvp01-20200325-00003”,”workflow”:{“type”:”batch”,”id”:”ical”,”version”:”0.1.0”},”parameters” :{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00001”,”type”:[“visibilities”]}]},{“id”: “pb-mvp01-20200325-00004”,”workflow”:{“type”:”batch”,”id”:”dpreb”,”version”:”0.1.0”},”parameters” :{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00003”,”type”:[“calibration”]}]}]}

Note: Enter input without spaces

Returns:

None

Raises:

ValueError if input argument json string contains invalid value.

DevFailed if the command execution is not successful.

class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.configure_command.Configure(*args, **kwargs)

A class for SdpSubarrayLeafNode’s Configure() command.

Configures the SDP Subarray device by providing the SDP PB configuration needed to execute the receive workflow

do(argin)

Method to invoke Configure command on SDP Subarray.

Parameters:argin – The string in JSON format. The JSON contains following values:

Example:

{ “scan_type”: “science_A” }

Returns:

None

Raises:

ValueError if input argument json string contains invalid value.

KeyError if input argument json string contains invalid key.

DevFailed if the command execution is not successful

class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.end_command.End(*args, **kwargs)

A class for SdpSubarrayLeafNode’s End command.

This command invokes End command on SDP subarray to end the current Scheduling block.

do()

Method to invoke End command on SDP Subarray.

Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.endscan_command.EndScan(*args, **kwargs)

A class for SdpSubarrayLeafNode’s EndScan() command.

It invokes EndScan command on SdpSubarray. This command is allowed when SdpSubarray is in SCANNING state.

do()

Method to invoke EndScan command on SDP Subarray.

Parameters:argin – None
Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.obsreset_command.ObsReset(*args, **kwargs)

A class for SdpSubarrayLeafNode’s ObsResetCommand() command.

Command to reset the SDP subarray and bring it to its RESETTING state.

do()

Method to invoke ObsReset command on SDP Subarray.

Parameters:argin – None
Returns:None
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.off_command.Off(*args, **kwargs)

A class for SDP Subarray’s Off() command.

Invokes Off command on the SDP Subarray.

do()

Method to invoke Off command on SDP Subarray.

Parameters:argin – None.
Returns:A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:(ResultCode, str)
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.on_command.On(*args, **kwargs)

A class for SDP Subarray’s On() command.

Invokes On command on the SDP Subarray.

do()

Method to invoke On command on SDP Subarray.

Parameters:argin – None.
Returns:A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:(ResultCode, str)
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.release_resources_command.ReleaseAllResources(*args, **kwargs)

A class for SdpSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given SDPSubarrayLeafNode. It accepts the subarray id, releaseALL flag and receptorIDList in JSON string format.

do()

Method to invoke ReleaseResources command on SDP Subarray.

Parameters:argin – None.
Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.restart_command.Restart(*args, **kwargs)

A class for sdpSubarrayLeafNode’s Restart() command.

Command to restart the SDP subarray and bring it to its ON state.

do()

Method to invoke Restart command on SDP Subarray.

Returns:None
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.scan_command.Scan(*args, **kwargs)

A class for SdpSubarrayLeafNode’s Scan() command.

Invoke Scan command to SDP subarray.

do(argin)

Method to invoke Scan command on SDP Subarray.

Parameters:argin – The string in JSON format. The JSON contains following values:

Example: {“id”:1}

Note: Enter input as without spaces:{“id”:1}

Returns:None
Raises:DevFailed if the command execution is not successful.