SKA Subarray

SKASubarray

A SubArray handling device. It allows the assigning/releasing of resources into/from Subarray, configuring capabilities, and exposes the related information like assigned resources, configured capabilities, etc.

class ska_tango_base.SKASubarray(*args, **kwargs)

Implements the SKA SubArray device

Abort()

Abort any long-running command such as Configure() or Scan().

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class AbortCommand(target, state_model, logger=None)

A class for SKASubarray’s Abort() command.

do()

Stateless hook for Abort() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

AssignResources(argin)

Assign resources to this subarray

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin (list of str) – the resources to be assigned Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class AssignResourcesCommand(target, state_model, logger=None)

A class for SKASubarray’s AssignResources() command.

do(argin)

Stateless hook for AssignResources() command functionality.

Parameters:argin (list of str) – The resources to be assigned Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

CapabilityTypes

Used by autodoc_mock_imports.

Configure(argin)

Configures the capabilities of this subarray

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin (string) – configuration specification Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class ConfigureCommand(target, state_model, logger=None)

A class for SKASubarray’s Configure() command.

do(argin)

Stateless hook for Configure() command functionality.

Parameters:argin (str) – The configuration as JSON Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

End()

End the scan block.

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class EndCommand(target, state_model, logger=None)

A class for SKASubarray’s End() command.

do()

Stateless hook for End() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

EndScan()

End the scan

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class EndScanCommand(target, state_model, logger=None)

A class for SKASubarray’s EndScan() command.

do()

Stateless hook for EndScan() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class InitCommand(target, state_model, logger=None)

A class for the SKASubarray’s init_device() “command”.

do()

Stateless hook for device initialisation.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

ObsReset()

Reset the current observation process.

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class ObsResetCommand(target, state_model, logger=None)

A class for SKASubarray’s ObsReset() command.

do()

Stateless hook for ObsReset() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

ReleaseAllResources()

Remove all resources to tear down to an empty subarray.

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class ReleaseAllResourcesCommand(target, state_model, logger=None)

A class for SKASubarray’s ReleaseAllResources() command.

do()

Stateless hook for ReleaseAllResources() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

ReleaseResources(argin)

Delta removal of assigned resources.

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin (list of str) – the resources to be released Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class ReleaseResourcesCommand(target, state_model, logger=None)

A class for SKASubarray’s ReleaseResources() command.

do(argin)

Stateless hook for ReleaseResources() command functionality.

Parameters:argin (list of str) – The resources to be released Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

Restart()

Restart the subarray. That is, deconfigure and release all resources.

To modify behaviour for this command, modify the do() method of the command class.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class RestartCommand(target, state_model, logger=None)

A class for SKASubarray’s Restart() command.

do()

Stateless hook for Restart() command functionality.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

Scan(argin)

Start scanning

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin (Array of str) – Information about the scan Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

class ScanCommand(target, state_model, logger=None)

A class for SKASubarray’s Scan() command.

do(argin)

Stateless hook for Scan() command functionality.

Parameters:argin (str) – Scan info Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only. Return type:(ResultCode, str)

SubID

Used by autodoc_mock_imports.

activationTime

Used by autodoc_mock_imports.

always_executed_hook()

Method that is always executed before any device command gets executed.

assignedResources

Used by autodoc_mock_imports.

configuredCapabilities

Used by autodoc_mock_imports.

delete_device()

Method to cleanup when device is stopped.

init_command_objects()

Sets up the command objects

is_Abort_allowed()

Check if command Abort is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_AssignResources_allowed()

Check if command AssignResources is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_Configure_allowed()

Check if command Configure is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_EndScan_allowed()

Check if command EndScan is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_End_allowed()

Check if command End is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_ObsReset_allowed()

Check if command ObsReset is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_ReleaseAllResources_allowed()

Check if command ReleaseAllResources is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_ReleaseResources_allowed()

Check if command ReleaseResources is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_Restart_allowed()

Check if command Restart is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

is_Scan_allowed()

Check if command Scan is allowed in the current device state.

Raises:tango.DevFailed – if the command is not allowed Returns:True if the command is allowed Return type:boolean

read_activationTime()

Reads the time since device is activated.

Returns:Time of activation in seconds since Unix epoch.

read_assignedResources()

Reads the resources assigned to the device.

Returns:Resources assigned to the device.

read_configuredCapabilities()

Reads capabilities configured in the Subarray.

Returns:A list of capability types with no. of instances used in the Subarray