SKA CSP Sub-element Subarray

This module implements a generic Subarray device for a CSP Sub-element. The scope of this module is to provide a uniform access to a CSP Sub-element subarray from the CSP.LMC side.

CspSubElementSubarray

Subarray device for SKA CSP SubElement

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

Subarray device for SKA CSP SubElement

Configure(argin)

Redirect to ConfigureScan method. Configure a complete scan for the subarray.

:return:’DevVarLongStringArray’

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

ConfigureScan(argin)

Configure a complete scan for the subarray.

Parameters:argin ('DevString') – JSON formatted string with the scan configuration. 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 ConfigureScanCommand(target, state_model, logger=None)

A class for the CspSubElementObsDevices’s ConfigureScan command.

do(argin)

Stateless hook for ConfigureScan() command functionality.

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

validate_input(argin)

Validate the configuration parameters against allowed values, as needed. :param argin: The JSON formatted string with configuration for the device. :type argin: ‘DevString’ :return: A tuple containing a return code and a string message. :rtype: (ResultCode, str)

End()

Transit the subarray from READY to IDLE obsState. Redirect to GoToIdle command.

:return:’DevVarLongStringArray’

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

GoToIdle()

Transit the subarray from READY to IDLE obsState.

:return:’DevVarLongStringArray’

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class GoToIdleCommand(target, state_model, logger=None)

A class for the CspSubElementObsDevices’s GoToIdle command.

do()

Stateless hook for GoToIdle() 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 CspSubElementObsDevice’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)

always_executed_hook()

Method always executed before any TANGO command is executed.

assignResourcesMaximumDuration

Used by autodoc_mock_imports.

assignResourcesMeasuredDuration

Used by autodoc_mock_imports.

assignResourcesProgress

Used by autodoc_mock_imports.

assignResourcesTimeoutExpiredFlag

Used by autodoc_mock_imports.

configurationID

Used by autodoc_mock_imports.

configureScanMeasuredDuration

Used by autodoc_mock_imports.

configureScanTimeoutExpiredFlag

Used by autodoc_mock_imports.

delete_device()

Hook to delete resources allocated in init_device.

This method allows for any memory or other resources allocated in the init_device method to be released. This method is called by the device destructor and by the device Init command.

init_command_objects()

Sets up the command objects

lastScanConfiguration

Used by autodoc_mock_imports.

listOfDevicesCompletedTasks

Used by autodoc_mock_imports.

outputDataRateToSdp

Used by autodoc_mock_imports.

read_assignResourcesMaximumDuration()

Return the assignResourcesMaximumDuration attribute.

read_assignResourcesMeasuredDuration()

Return the assignResourcesMeasuredDuration attribute.

read_assignResourcesProgress()

Return the assignResourcesProgress attribute.

read_assignResourcesTimeoutExpiredFlag()

Return the assignResourcesTimeoutExpiredFlag attribute.

read_configurationID()

Return the configurationID attribute.

read_configureScanMeasuredDuration()

Return the configureScanMeasuredDuration attribute.

read_configureScanTimeoutExpiredFlag()

Return the configureScanTimeoutExpiredFlag attribute.

read_lastScanConfiguration()

Return the lastScanConfiguration attribute.

read_listOfDevicesCompletedTasks()

Return the listOfDevicesCompletedTasks attribute.

read_outputDataRateToSdp()

Return the outputDataRateToSdp attribute.

read_releaseResourcesMaximumDuration()

Return the releaseResourcesMaximumDuration attribute.

read_releaseResourcesMeasuredDuration()

Return the releaseResourcesMeasuredDuration attribute.

read_releaseResourcesProgress()

Return the releaseResourcesProgress attribute.

read_releaseResourcesTimeoutExpiredFlag()

Return the releaseResourcesTimeoutExpiredFlag attribute.

read_scanID()

Return the scanID attribute.

read_sdpDestinationAddresses()

Return the sdpDestinationAddresses attribute.

read_sdpLinkActive()

Return the sdpLinkActive attribute.

releaseResourcesMaximumDuration

Used by autodoc_mock_imports.

releaseResourcesMeasuredDuration

Used by autodoc_mock_imports.

releaseResourcesProgress

Used by autodoc_mock_imports.

releaseResourcesTimeoutExpiredFlag

Used by autodoc_mock_imports.

scanID

Used by autodoc_mock_imports.

sdpDestinationAddresses

Used by autodoc_mock_imports.

sdpLinkActive

Used by autodoc_mock_imports.

write_assignResourcesMaximumDuration(value)

Set the assignResourcesMaximumDuration attribute.

write_releaseResourcesMaximumDuration(value)

Set the releaseResourcesMaximumDuration attribute.

write_sdpDestinationAddresses(value)

Set the sdpDestinationAddresses attribute.