FspPssSubarray Class

class ska_mid_cbf_mcs.fsp.fsp_pss_subarray_device.FspPssSubarray(*args: Any, **kwargs: Any)[source]

Bases: CspSubElementObsDevice

FspPssSubarray TANGO device class for the FspPssSubarray prototype

init_command_objects() → None[source]: Sets up the command objects

class InitCommand(*args: Any, **kwargs: Any)[source]

Bases: InitCommand

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

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

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() → None[source]: Hook to be executed before any commands.

create_component_manager() → FspPssSubarrayComponentManager[source]

Create and return a component manager for this device.

Returns:: a component manager for this device.

delete_device() → None[source]: Hook to delete device.

read_receptors() → List[int][source]

Read the receptors attribute.

Returns:: the receptors attribute.
Return type:: List[int]

read_searchBeams() → List[str][source]

Read the searchBeams attribute.

Returns:: the searchBeams attribute.
Return type:: List[str]

read_searchBeamID() → List[int][source]

Read the searchBeamID attribute.

Returns:: the searchBeamID attribute.
Return type:: List[int]

read_searchWindowID() → List[int][source]

Read the searchWindowID attribute.

Returns:: the searchWindowID attribute.
Return type:: List[int]

read_outputEnable() → bool[source]

Read the outputEnable attribute. Used to enable/disable transmission of the output products.

Returns:: the outputEnable attribute.
Return type:: bool

read_scanID() → int[source]

Read the scanID attribute.

Returns:: the scanID attribute.
Return type:: int

write_scanID(value: int) → None[source]

Write the scanID attribute.

Parameters:: value – the scanID attribute value.

read_configID() → str[source]

Read the configID attribute.

Returns:: the configID attribute.
Return type:: str

write_configID(value: str) → None[source]

Write the configID attribute.

Parameters:: value – the configID attribute value.

class OnCommand(*args: Any, **kwargs: Any)[source]

Bases: OnCommand

A class for the FspPssSubarray’s On() command.

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

Stateless hook for On() 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 OffCommand(*args: Any, **kwargs: Any)[source]

Bases: OffCommand

A class for the FspPssSubarray’s Off() command.

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

Stateless hook for Off() 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 StandbyCommand(*args: Any, **kwargs: Any)[source]

Bases: StandbyCommand

A class for the FspPssSubarray’s Standby() command.

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

Stateless hook for Standby() 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 ConfigureScanCommand(*args: Any, **kwargs: Any)[source]

Bases: ConfigureScanCommand

A class for the FspPssSubarray’s ConfigureScan() command.

do(argin: str) → Tuple[ska_tango_base.commands.ResultCode, str][source]

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)
Raises:: CommandError if the configuration data validation fails.

validate_input(argin: str) → Tuple[bool, str][source]

Validate the configuration parameters against allowed values, as needed.

Parameters:: argin – The JSON formatted string with configuration for the device. :type argin: ‘DevString’
Returns:: A tuple containing a boolean and a string message.
Return type:: (bool, str)

class ScanCommand(*args: Any, **kwargs: Any)[source]

Bases: ScanCommand

A class for the FspPssSubarray’s Scan() command.

do(argin: str) → Tuple[ska_tango_base.commands.ResultCode, str][source]

Stateless hook for Scan() command functionality.

Parameters:: argin (str) – The scan ID
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)
Raises:: CommandError if the configuration data validation fails.

class EndScanCommand(*args: Any, **kwargs: Any)[source]

Bases: EndScanCommand

A class for the FspPssSubarray’s Scan() command.

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

Stateless hook for Scan() 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)
Raises:: CommandError if the configuration data validation fails.

class GoToIdleCommand(*args: Any, **kwargs: Any)[source]

Bases: GoToIdleCommand

A class for the FspPssSubarray’s GoToIdle command.

do() → Tuple[ska_tango_base.commands.ResultCode, str][source]

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)