Helper_MCCS_Master_Leaf_Node_Device
This module implements the Helper MCCS master leaf node devices for testing an integrated TMC
- class ska_tmc_simulators.helper_mccs_master_leaf_node_device.HelperMCCSMasterLeafNode(*args: Any, **kwargs: Any)
Bases:
HelperBaseDeviceA helper MCCS master leafnode device for triggering state changes with a command
- InitCommand = None
- init_device() None
- read_mccsControllerAdminMode() int
Reads the current admin mode of the mccs controller
- Returns:
obs state
- SetMccsControllerAdminMode(argin: int) None
Trigger a admin mode change
- Parameters:
argin – adminMode enum to set the admin mode.
- Dtype:
int
- is_AssignResources_allowed() bool
Check if command AssignResources is allowed in the current device state.
- Returns:
Trueif the command is allowed- Return type:
bool
- Raises:
CommandNotAllowed – command is not allowed
- AssignResources(argin: str) Tuple[List[ska_tango_base.commands.ResultCode], List[str]]
This method invokes AssignResources command on MCCS master leaf node device.
- Returns:
a tuple containing ResultCode and Message
- Return type:
Tuple
- is_ReleaseAllResources_allowed() bool
Check if command ReleaseAllResources is allowed in the current device state.
- Returns:
Trueif the command is allowed- Raises:
CommandNotAllowed – command is not allowed
- Return type:
bool
- ReleaseAllResources(argin: str) Tuple[List[ska_tango_base.commands.ResultCode], List[str]]
This method invokes ReleaseAllResources command on MCCS master leaf node device.
- Returns:
a tuple containing ResultCode and Message
- Return type:
Tuple
- is_Abort_allowed() bool
This method checks if the Abort command is allowed in the current device state.
- Returns:
Trueif the command is allowed- Return type:
bool
- Raises:
CommandNotAllowed – command is not allowed
- Abort(argin: int) Tuple[List[ska_tango_base.commands.ResultCode], List[str]]
This is the method to invoke Abort command.
- Parameters:
argin – an integer subarray_id.
- Returns:
ResultCode, command id
- Return type:
tuple