ska_tmc_mccssubarrayleafnode package

Subpackages

Submodules

ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node module

MCCSSubarrayLeafnode acts as a contact point for the MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray.

class ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node.MccsSubarrayLeafNode(*args: Any, **kwargs: Any)

Bases: SKABaseDevice

MCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also to monitor and issue commands to the MCCS Subarray.

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

Bases: InitCommand

A class for the TMC MccsSubarrayLeafNode’s init_device() method.

do(*args, **kwargs)

Initializes the attributes and properties of the MccsSubarrayLeafNode.

Returns:

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

rtype:

(ResultCode, str)

always_executed_hook()
create_component_manager()

Returns Mccs Subarray Leaf Node component manager object

delete_device()
init_command_objects() None

Initialises the command handlers for commands supported by this device.

is_Configure_allowed() bool

Checks whether Configure command is allowed to be run in current device state returns A bool or raises CommandNotAllowed exception. :return: A bool or raises CommandNotAllowed exception. :rtype: boolean

is_EndScan_allowed() bool

Checks whether EndScan command is allowed to be run in current device state.

Returns:

True if EndScan command is allowed to be run in current device state.

rtype:

boolean

is_End_allowed() bool

Checks whether End command is allowed to be run in current device state.

Returns:

True if End command is allowed to be run in current device state.

rtype:

boolean

is_Scan_allowed() bool

Checks whether Scan command is allowed to be run in current device state. :return: True if Scan command is allowed to be run in current device state

Return type:

boolean

read_isSubsystemAvailable()

Returns the TMC Mccs SubarrayLeafNode isSubsystemAvailable attribute.

read_mccsSubarrayDevName()

Returns the mccssubarraydevname attribute.

read_obsState()

Read method for obsState

update_availablity_callback(availablity)

Change event callback for isSubsystemAvailable

update_mccs_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) None

Change event callback for obsState

write_mccsSubarrayDevName(value)

Sets the mccssubarraydevname attribute.

ska_tmc_mccssubarrayleafnode.mccs_subarray_leaf_node.main(args=None, **kwargs)

Runs the MccsSubarrayLeafNode. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

Returns:

MccsSubarrayLeafNode TANGO object.

Module contents

Init module of MccsSubarrayLeafNode.

class ska_tmc_mccssubarrayleafnode.MccsSubarrayLeafNode(*args: Any, **kwargs: Any)

Bases: SKABaseDevice

MCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also to monitor and issue commands to the MCCS Subarray.

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

Bases: InitCommand

A class for the TMC MccsSubarrayLeafNode’s init_device() method.

do(*args, **kwargs)

Initializes the attributes and properties of the MccsSubarrayLeafNode.

Returns:

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

rtype:

(ResultCode, str)

always_executed_hook()
create_component_manager()

Returns Mccs Subarray Leaf Node component manager object

delete_device()
init_command_objects() None

Initialises the command handlers for commands supported by this device.

is_Configure_allowed() bool

Checks whether Configure command is allowed to be run in current device state returns A bool or raises CommandNotAllowed exception. :return: A bool or raises CommandNotAllowed exception. :rtype: boolean

is_EndScan_allowed() bool

Checks whether EndScan command is allowed to be run in current device state.

Returns:

True if EndScan command is allowed to be run in current device state.

rtype:

boolean

is_End_allowed() bool

Checks whether End command is allowed to be run in current device state.

Returns:

True if End command is allowed to be run in current device state.

rtype:

boolean

is_Scan_allowed() bool

Checks whether Scan command is allowed to be run in current device state. :return: True if Scan command is allowed to be run in current device state

Return type:

boolean

read_isSubsystemAvailable()

Returns the TMC Mccs SubarrayLeafNode isSubsystemAvailable attribute.

read_mccsSubarrayDevName()

Returns the mccssubarraydevname attribute.

read_obsState()

Read method for obsState

update_availablity_callback(availablity)

Change event callback for isSubsystemAvailable

update_mccs_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) None

Change event callback for obsState

write_mccsSubarrayDevName(value)

Sets the mccssubarraydevname attribute.