Subarray Device

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

Implements the SKA SubArray device.

class InitCommand(device: tango.server.Device, logger: Optional[Logger] = None, validator: Optional[ArgumentValidator] = None)

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

do(*args: Any, **kwargs: Any) → tuple[ska_control_model.result_code.ResultCode, str]

Stateless hook for device initialisation.

Parameters:

• args – positional arguments to the command. This command does not take any, so this should be empty.

• kwargs – keyword arguments to the command. This command does not take any, so this should be empty.

Returns:

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

class AssignResourcesCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None, schema: Optional[dict[str, Any]] = None)

A class for SKASubarray’s AssignResources() command.

class ReleaseResourcesCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None, schema: Optional[dict[str, Any]] = None)

A class for SKASubarray’s ReleaseResources() command.

class ReleaseAllResourcesCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None)

A class for SKASubarray’s ReleaseAllResources() command.

class ConfigureCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None, schema: Optional[dict[str, Any]] = None)

A class for SKASubarray’s Configure() command.

class ScanCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None, schema: Optional[dict[str, Any]] = None)

A class for SKASubarray’s Scan() command.

class EndScanCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None)

A class for SKASubarray’s EndScan() command.

class EndCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None)

A class for SKASubarray’s End() command.

class AbortCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Callable[[bool], None], logger: Optional[Logger] = None)

A class for SKASubarray’s Abort() command.

do(*args: Any, **kwargs: Any) → tuple[ska_control_model.result_code.ResultCode, str]

Stateless hook for Abort() command functionality.

Parameters:

• args – positional arguments to the command. This command does not take any, so this should be empty.

• kwargs – keyword arguments to the command. This command does not take any, so this should be empty.

Returns:

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

class ObsResetCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None)

A class for SKASubarray’s ObsReset() command.

class RestartCommand(command_tracker: CommandTracker, component_manager: SubarrayComponentManager, callback: Optional[Callable[[bool], None]] = None, logger: Optional[Logger] = None)

A class for SKASubarray’s Restart() command.

create_component_manager() → ComponentManagerT

Create and return a component manager for this device.

Raises:

NotImplementedError – because it is not implemented.

init_command_objects() → None

Set up the command objects.

activationTime() → float

Read the time of activation in seconds since Unix epoch.

Returns:

Time of activation in seconds since Unix epoch.

assignedResources() → list[str]

Read the resources assigned to the device.

The list of resources assigned to the subarray.

Returns:

Resources assigned to the device.

configuredCapabilities() → list[str]

Read capabilities configured in the Subarray.

A list of capability types with no. of instances in use on this subarray; e.g. Correlators:512, PssBeams:4 PstBeams:4, VlbiBeams:0.

Returns:

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

is_AssignResources_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_ReleaseResources_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_ReleaseAllResources_allowed() → bool

Return whether ReleaseAllResources may be called in the current device state.

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_Configure_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_Scan_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_EndScan_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_End_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_Abort_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_ObsReset_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

is_Restart_allowed() → bool

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

Raises:

StateModelError – command not permitted in observation state

Returns:

whether the command may be called in the current device state

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

Entry point for module.

Parameters:

• args – positional arguments

• kwargs – named arguments

Returns:

exit code