ska_tmc_sdpsubarrayleafnode.commands package

Submodules

ska_tmc_sdpsubarrayleafnode.commands.abstract_command module

class ska_tmc_sdpsubarrayleafnode.commands.abstract_command.AbstractOnOff(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

class ska_tmc_sdpsubarrayleafnode.commands.abstract_command.AbstractRestartObsReset(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

class ska_tmc_sdpsubarrayleafnode.commands.abstract_command.AbstractScanEnd(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

class ska_tmc_sdpsubarrayleafnode.commands.abstract_command.SdpSLNCommand(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

check_allowed()
check_op_state(command_name)
check_unresponsive()
init_adapter()

ska_tmc_sdpsubarrayleafnode.commands.off_command module

Off command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpsubarrayLeafNode’s Off() command.

Off command on SdpsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Sdp Subarray device.

do(argin=None)

Method to invoke Telescope Off command on Sdp Subarray.

ska_tmc_sdpsubarrayleafnode.commands.on_command module

On command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpsubarrayLeafNode’s On() command.

On command on SdpsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Sdp Subarray device.

do(argin=None)

Method to invoke Telescope On command on Sdp Subarray.

ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command module

AssignResouces command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command.AssignResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

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.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin)

Method to invoke AssignResources command on SDP Subarray.

Parameters

argin

The string in JSON format. The JSON contains following values:

eb_id and maximum length of the SBI: Mandatory JSON object consisting of

eb_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

{“interface”:”https://schema.skao.int/ska-sdp-assignres/0.3”, “eb_id”:”eb-mvp01-20200325-00001”,”max_length”:100.0,”scan_types”:[{“scan_type_id”:”science_A”, “reference_frame”:”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]]}]} ,{“scan_type_id”:”calibration_B”,”reference_frame”:”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”:[{“pb_id”:”pb-mvp01-20200325-00001”,”workflow”: {“kind”:”realtime”,”name”:”vis_receive”,”version”:”0.1.0”},”parameters”:{}},{“pb_id”: “pb-mvp01-20200325-00002”,”workflow”:{“kind”:”realtime”,”name”:”test_realtime”,”version”:”0.1.0”}, “parameters”:{}},{“pb_id”:”pb-mvp01-20200325-00003”,”workflow”:{“kind”:”batch”,”name”:”ical”, “version”:”0.1.0”},”parameters”:{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00001”, “kind”:[“visibilities”]}]},{“pb_id”:”pb-mvp01-20200325-00004”,”workflow”:{“kind”:”batch”,”name”:”dpreb”, “version”:”0.1.0”},”parameters”:{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00003”,”kind”: [“calibration”]}]}]}

Note: Enter input without spaces

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.configure_command module

Configure command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.configure_command.Configure(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Configure() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin)

Method to invoke Configure command on SDP Subarray.

Parameters

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

Example

{ “interface”: “https://schema.skao.int/ska-sdp-configure/0.3”, “scan_type”: “science_A” }

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.end_command module

End command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.end_command.End(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s End() command.

Invokes End command on SDP Subarray to end the current Scheduling Block.

do(argin=None)

Method to invoke End command on SDP Subarray.

Parameters

argin – None

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.endscan_command module

EndScan command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.endscan_command.EndScan(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s EndScan() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke EndScan command on SDP Subarray.

ska_tmc_sdpsubarrayleafnode.commands.obsreset_command module

ObsReset command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.obsreset_command.ObsReset(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s ObsReset() command.

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

do(argin=None)

Method to invoke ObsReset command on SDP Subarray.

Parameters

argin – None

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.release_resources_command module

ReleaseResources command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.release_resources_command.ReleaseResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarayLeafNode’s ReleaseResources() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke ReleaseResources command on SDP Subarray.

Parameters

argin – None.

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.reset_command module

Reset command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.reset_command.Reset(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Reset() command.

Command to reset the SDP Subarray and bring it to its initial state.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke Reset command on SDP Subarray.

Parameters

argin – None

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.restart_command module

Restart command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.restart_command.Restart(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Restart() command.

Command to reset the SDP Subarray and bring it to its RESTARTING state.

do(argin=None)

Method to invoke Restart command on SDP Subarray.

Parameters

argin – None

Returns

None

ska_tmc_sdpsubarrayleafnode.commands.scan_command module

Scan command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.scan_command.Scan(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

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

{

“interface”: “https://schema.skao.int/ska-sdp-scan/0.3”, “scan_id”: 1

}

Returns

None

Module contents

class ska_tmc_sdpsubarrayleafnode.commands.Abort(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Abort() command.

Command to abort the SDP Subarray and bring it to its ABORTED state.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke Abort command on SDP Subarray.

Parameters

argin – None

Returns

None

Raises

Exception if error occurs while invoking command on SDP Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.AssignResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

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.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin)

Method to invoke AssignResources command on SDP Subarray.

Parameters

argin

The string in JSON format. The JSON contains following values:

eb_id and maximum length of the SBI: Mandatory JSON object consisting of

eb_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

{“interface”:”https://schema.skao.int/ska-sdp-assignres/0.3”, “eb_id”:”eb-mvp01-20200325-00001”,”max_length”:100.0,”scan_types”:[{“scan_type_id”:”science_A”, “reference_frame”:”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]]}]} ,{“scan_type_id”:”calibration_B”,”reference_frame”:”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”:[{“pb_id”:”pb-mvp01-20200325-00001”,”workflow”: {“kind”:”realtime”,”name”:”vis_receive”,”version”:”0.1.0”},”parameters”:{}},{“pb_id”: “pb-mvp01-20200325-00002”,”workflow”:{“kind”:”realtime”,”name”:”test_realtime”,”version”:”0.1.0”}, “parameters”:{}},{“pb_id”:”pb-mvp01-20200325-00003”,”workflow”:{“kind”:”batch”,”name”:”ical”, “version”:”0.1.0”},”parameters”:{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00001”, “kind”:[“visibilities”]}]},{“pb_id”:”pb-mvp01-20200325-00004”,”workflow”:{“kind”:”batch”,”name”:”dpreb”, “version”:”0.1.0”},”parameters”:{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00003”,”kind”: [“calibration”]}]}]}

Note: Enter input without spaces

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.Configure(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Configure() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin)

Method to invoke Configure command on SDP Subarray.

Parameters

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

Example

{ “interface”: “https://schema.skao.int/ska-sdp-configure/0.3”, “scan_type”: “science_A” }

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.End(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s End() command.

Invokes End command on SDP Subarray to end the current Scheduling Block.

do(argin=None)

Method to invoke End command on SDP Subarray.

Parameters

argin – None

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.EndScan(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s EndScan() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke EndScan command on SDP Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.ObsReset(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s ObsReset() command.

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

do(argin=None)

Method to invoke ObsReset command on SDP Subarray.

Parameters

argin – None

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.Off(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpsubarrayLeafNode’s Off() command.

Off command on SdpsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Sdp Subarray device.

do(argin=None)

Method to invoke Telescope Off command on Sdp Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpsubarrayLeafNode’s On() command.

On command on SdpsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Sdp Subarray device.

do(argin=None)

Method to invoke Telescope On command on Sdp Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.ReleaseResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarayLeafNode’s ReleaseResources() command.

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

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke ReleaseResources command on SDP Subarray.

Parameters

argin – None.

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.Reset(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Reset() command.

Command to reset the SDP Subarray and bring it to its initial state.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke Reset command on SDP Subarray.

Parameters

argin – None

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.Restart(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for SdpSubarrayLeafNode’s Restart() command.

Command to reset the SDP Subarray and bring it to its RESTARTING state.

do(argin=None)

Method to invoke Restart command on SDP Subarray.

Parameters

argin – None

Returns

None

class ska_tmc_sdpsubarrayleafnode.commands.Scan(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

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

{

“interface”: “https://schema.skao.int/ska-sdp-scan/0.3”, “scan_id”: 1

}

Returns

None