Helper_Subarray_Leaf_Device

This module implements the Helper devices for subarray leaf nodes for testing an integrated TMC

class ska_tmc_simulators.helper_subarray_leaf_device.HelperSubarrayLeafDevice(*args: Any, **kwargs: Any)

Bases: HelperBaseDevice

A device exposing commands and attributes of the Subarray Leaf Nodes devices.

InitCommand = None

init_device() → None

read_obsStateTransitionDuration()

Read transition

Returns:

state duration info

read_commandCallInfo()

This method is used to read the attribute value for commandCallInfo.

Returns:

attribute value for commandCallInfo

read_defective() → str

Returns defective status of devices

Returns:

attribute value defective

Return type:

str

read_obsState() → int

This method is used to read the attribute value for obsState.

Returns:

attribute value for obsstate

update_command_info(command_name: str = '', command_input: str = '') → None

This method updates the commandCallInfo attribute, with the respective command information.

Args:

• command_name (str): command name

• command_input (str): Input argin for command

ClearCommandCallInfo() → None

Clears commandCallInfo to empty list

AddTransition(state_duration_info: str) → None

This command will establish a duration for the observation state, so that when the corresponding command for the observation state is triggered,it will transition to a provided observation state after the specified duration

ResetTransitions() → None

This command will reset ObsState duration which is set

SetDirectObsState(value: int) → None

Trigger defective change

Param:

values

Type:

str

push_obs_state_event(obs_state: int) → None

This Method pushes change event for subarray observation state

Args:

obs_state (ObsState): Observation state of subarray

is_AssignResources_allowed() → bool

This method checks if the AssignResources command is allowed or not

Returns:

True if the command is allowed

Raises:

CommandNotAllowed – command is not allowed

AssignResources(argin: str = '') → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke AssignResources command.

Returns:

ResultCode, message

Return type:

tuple

is_Configure_allowed() → bool

This method checks the Configure is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

Configure(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke Configure command.

Returns:

ResultCode, message

Return type:

tuple

is_Scan_allowed() → bool

This method checks if the Scan command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

Scan(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke Scan command.

Returns:

ResultCode, message

Return type:

tuple

is_EndScan_allowed() → bool

This method checks if the EndScan command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

EndScan() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke EndScan command.

Returns:

ResultCode, message

Return type:

tuple

is_End_allowed() → bool

This method checks if the End command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

End() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke End command.

Returns:

ResultCode, message

Return type:

tuple

is_GoToIdle_allowed() → bool

This method checks if the GoToIdle command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

GoToIdle() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke GoToIdle command.

Returns:

ResultCode, message

Return type:

tuple

is_Abort_allowed() → bool

This method checks if the Abort command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

Abort() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke Abort command.

Returns:

ResultCode, message

Return type:

tuple

is_Restart_allowed() → bool

This method checks if the Restart command is allowed in the current device state.

Returns:

True if the command is allowed

Return type:

bool

Raises:

CommandNotAllowed – command is not allowed

Restart() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke Restart command.

Returns:

ResultCode, message

Return type:

tuple

is_ReleaseAllResources_allowed() → bool

This method checks if the ReleaseAllResources command is allowed in the current device state.

Returns:

True if the command is allowed

Raises:

CommandNotAllowed – command is not allowed

Return type:

bool

ReleaseAllResources() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke ReleaseAllResources command.

Returns:

ResultCode, message

Return type:

tuple

is_ReleaseResources_allowed() → bool

This method checks if the ReleaseResources command is allowed in the current device state.

Returns:

True if the command is allowed

Raises:

CommandNotAllowed – command is not allowed

Return type:

bool

ReleaseResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This is the method to invoke ReleaseResources command.

Returns:

ResultCode, message

Return type:

tuple