Obs device

CspSubElementObsDevice.

General observing device for SKA CSP Subelement.

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

General observing device for SKA CSP Subelement.

Properties:

  • Device Property
    DeviceID

    • Identification number of the observing device.

    • Type:’DevUShort’

scanID

Device attribute.

configurationID

Device attribute.

deviceID

Device attribute.

lastScanConfiguration

Device attribute.

sdpDestinationAddresses

Device attribute.

sdpLinkCapacity

Device attribute.

sdpLinkActive

Device attribute.

healthFailureMessage

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_deviceID() → int

Return the deviceID attribute.

Returns:

the deviceID attribute.

read_lastScanConfiguration() → str

Return the lastScanConfiguration attribute.

Returns:

the lastScanConfiguration attribute.

read_sdpDestinationAddresses() → str

Return the sdpDestinationAddresses attribute.

Returns:

the sdpDestinationAddresses attribute.

read_sdpLinkCapacity() → float

Return the sdpLinkCapacity attribute.

Returns:

the sdpLinkCapacity attribute.

read_sdpLinkActive() → list[bool]

Return the sdpLinkActive attribute.

Returns:

the sdpLinkActive attribute.

read_healthFailureMessage() → str

Return the healthFailureMessage attribute.

Returns:

the healthFailureMessage 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 yuse

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

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

A class for the CspSubElementObsDevices’s Scan command.

Initialise a new ScanCommand instance.

Parameters:

  • command_tracker – the device’s command tracker

  • component_manager – the device’s component manager

  • callback – an optional callback to be called when this command starts and finishes.

  • logger – a logger for this command object to yuse

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

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

A class for the CspSubElementObsDevices’s Abort command.

Initialise a new AbortCommand 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 yuse

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

Stateless hook for Abort() command functionality.

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.

is_ConfigureScan_allowed() → bool

Return whether the ConfigureScan 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_Scan_allowed() → bool

Return whether the Scan 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

is_EndScan_allowed() → bool

Return whether the EndScan 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

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

is_ObsReset_allowed() → bool

Return whether the ObsReset 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

is_Abort_allowed() → bool

Return whether the Abort 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

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

Entry point for module.

Parameters:

  • args – positional arguments

  • kwargs – named arguments

Returns:

exit code