SDP Master Leaf Node

The primary responsibility of the SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation. It also acts as a SDP contact point for Subarray Node for observation execution. There is one to one mapping between SDP Subarray Leaf Node and SDP subarray.

class tmcprototype.sdpmasterleafnode.src.sdpmasterleafnode.sdp_master_leaf_node.SdpMasterLeafNode(*args: Any, **kwargs: Any)

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

Disable()

Sets the OperatingState to Disable.

Parameters

argin – None

Returns

None

class DisableCommand(*args: Any, **kwargs: Any)

A class for SDP master’s Disable() command.

check_allowed()

Check Whether this command is allowed to be run in current device state.

return

True if this command is allowed to be run in current device state.

rtype

boolean

raises

DevFailed if this command is not allowed to be run in current device state.

disable_cmd_ended_cb(event)

Callback function immediately executed when the asynchronous invoked command returns. Checks whether the disable command has been successfully invoked on SDP Master.

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()

Sets the OperatingState to Disable.

Parameters

argin – None.

Returns

None

class InitCommand(*args: Any, **kwargs: Any)

A class for the SDP master’s init_device() method”

do()

Initializes the attributes and properties of the SdpMasterLeafNode.

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

class OffCommand(*args: Any, **kwargs: Any)

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

do()

Sets the OperatingState to Off.

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)

off_cmd_ended_cb(event)

Callback function immediately executed when the asynchronous invoked command returns. Checks whether the OFF command has been successfully invoked on SDP Master.

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 OnCommand(*args: Any, **kwargs: Any)

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

do()

Informs the SDP that it can start executing Processing Blocks. Sets the OperatingState to ON.

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)

on_cmd_ended_cb(event)

Callback function immediately executed when the asynchronous invoked command returns. Checks whether the On command has been successfully invoked on SDP Master.

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

Standby()

Invokes Standby command .

Parameters

argin – None

Returns

None

class StandbyCommand(*args: Any, **kwargs: Any)

A class for SDP Master’s Standby() command.

check_allowed()

Check Whether this command is allowed to be run in current device state.

return

True if this command is allowed to be run in current device state.

rtype

boolean

raises

DevFailed if this command is not allowed to be run in current device state.

do()

Informs the SDP to stop any executing Processing. To get into the STANDBY state all running PBs will be aborted. In normal operation we expect diable should be triggered without first going into STANDBY.

Parameters

argin – None.

Returns

None

is_Standby_allowed()

Checks Whether this command is allowed to be run in current device 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.

standby_cmd_ended_cb(event)

Callback function immediately executed when the asynchronous invoked command returns. Checks whether the standby command has been successfully invoked on SDP Master.

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

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_Disable_allowed()

Checks Whether this command is allowed to be run in current device 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.

read_ProcessingBlockList()

Internal construct of TANGO. :return:

read_activityMessage()

Internal construct of TANGO. String providing information about the current activity in SDPLeafNode.

read_versionInfo()

Internal construct of TANGO. Version information of TANGO device.

write_activityMessage(value)

Internal construct of TANGO. Sets the activity message.

tmcprototype.sdpmasterleafnode.src.sdpmasterleafnode.sdp_master_leaf_node.main(args=None, **kwargs)