Subarray device

CspSubElementSubarray.

Subarray device for SKA CSP SubElement

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

A stub for a CSP subarray component manager.

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

Subarray device for SKA CSP SubElement.

scanID

Device attribute.

configurationID

Device attribute.

sdpDestinationAddresses

Device attribute.

outputDataRateToSdp

Device attribute.

lastScanConfiguration

Device attribute.

sdpLinkActive

Device attribute.

listOfDevicesCompletedTasks

Device attribute.

configureScanMeasuredDuration

Device attribute.

configureScanTimeoutExpiredFlag

Device attribute.

assignResourcesMaximumDuration

Device attribute.

assignResourcesMeasuredDuration

Device attribute.

assignResourcesTimeoutExpiredFlag

Device attribute.

releaseResourcesMaximumDuration

Device attribute.

releaseResourcesMeasuredDuration

Device attribute.

releaseResourcesTimeoutExpiredFlag

Device attribute.

init_command_objects() → None

Set up the command objects.

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

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

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device initialisation.

Parameters:

  • args – positional arguments to this do method

  • kwargs – keyword arguments to this do method

Returns:

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

create_component_manager() → ComponentManagerT

Create and return a component manager for this device.

Raises:

NotImplementedError – because it is not implemented.

read_scanID() → int

Return the scanID attribute.

Returns:

the scanID attribute.

read_configurationID() → str

Return the configurationID attribute.

Returns:

the configurationID attribute.

read_sdpDestinationAddresses() → str

Return the sdpDestinationAddresses attribute.

Returns:

the sdpDestinationAddresses attribute.

write_sdpDestinationAddresses(value: str) → None

Set the sdpDestinationAddresses attribute.

Parameters:

value – the SDP destination addresses

read_outputDataRateToSdp() → float

Return the outputDataRateToSdp attribute.

Returns:

the outputDataRateToSdp attribute.

read_lastScanConfiguration() → str

Return the lastScanConfiguration attribute.

Returns:

the lastScanConfiguration attribute.

read_configureScanMeasuredDuration() → float

Return the configureScanMeasuredDuration attribute.

Returns:

the configureScanMeasuredDuration attribute.

read_configureScanTimeoutExpiredFlag() → bool

Return the configureScanTimeoutExpiredFlag attribute.

Returns:

the configureScanTimeoutExpiredFlag attribute.

read_listOfDevicesCompletedTasks() → str

Return the listOfDevicesCompletedTasks attribute.

Returns:

the listOfDevicesCompletedTasks attribute.

read_assignResourcesMaximumDuration() → float

Return the assignResourcesMaximumDuration attribute.

Returns:

the assignResourcesMaximumDuration attribute.

write_assignResourcesMaximumDuration(value: float) → None

Set the assignResourcesMaximumDuration attribute.

Parameters:

value – the new maximum duration

read_assignResourcesMeasuredDuration() → float

Return the assignResourcesMeasuredDuration attribute.

Returns:

the assignResourcesMeasuredDuration attribute.

read_assignResourcesTimeoutExpiredFlag() → bool

Return the assignResourcesTimeoutExpiredFlag attribute.

Returns:

the assignResourcesTimeoutExpiredFlag attribute.

read_releaseResourcesMaximumDuration() → float

Return the releaseResourcesMaximumDuration attribute.

Returns:

the releaseResourcesMaximumDuration attribute.

write_releaseResourcesMaximumDuration(value: float) → None

Set the releaseResourcesMaximumDuration attribute.

Parameters:

value – the new maximum duration.

read_releaseResourcesMeasuredDuration() → float

Return the releaseResourcesMeasuredDuration attribute.

Returns:

the releaseResourcesMeasuredDuration attribute.

read_releaseResourcesTimeoutExpiredFlag() → bool

Return the releaseResourcesTimeoutExpiredFlag attribute.

Returns:

the releaseResourcesTimeoutExpiredFlag attribute.

read_sdpLinkActive() → list[bool]

Return the sdpLinkActive attribute.

Returns:

the sdpLinkActive attribute.

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

A class for the CspSubElementObsDevices’s ConfigureScan command.

Initialise a new ConfigureScanCommand instance.

Parameters:

  • command_tracker – the device’s command tracker

  • component_manager – the device’s component manager

  • callback – callback to be called when this command states and finishes

  • logger – a logger for this command object to use

  • schema – an optional JSON schema for the command argument.

is_ConfigureScan_allowed() → bool

Return whether the Configure command may be called in the current state.

Raises:

StateModelError – if the command is not allowed

Returns:

whether the command may be called in the current device state

is_Configure_allowed() → bool

Return whether the Configure command may be called in the current state.

Returns:

whether the command may be called in the current device state

is_GoToIdle_allowed() → bool

Return whether the GoToIdle command may be called in the current device state.

Raises:

StateModelError – if the command is not allowed

Returns:

whether the command may be called in the current device state. Can only return True, because an exception is raised in the case of False.

main(*args: str, **kwargs: str) → int

Entry point for module.

Parameters:

  • args – positional arguments

  • kwargs – named arguments

Returns:

exit code