ska_tmc_cspsubarrayleafnode.commands package

Submodules

ska_tmc_cspsubarrayleafnode.commands.abstract_command module

Abstract Command Class for Csp Subarray Leaf Node

class ska_tmc_cspsubarrayleafnode.commands.abstract_command.AbstractOnOff(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

Abstract class for CspSubarrayLeafNode

check_allowed()

Checks whether this command is allowed. It checks that the device is in the right state to execute this command and that all the components needed for the operation are not unresponsive.

Returns

True if this command is allowed

Return type

boolean

class ska_tmc_cspsubarrayleafnode.commands.abstract_command.CspSLNCommand(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

Abstract command class for all CspSubarrayLeafNode

check_op_state(command_name)

Checks the operational state of device

check_unresponsive()

Checks whether the device is unresponsive

init_adapter()

ska_tmc_cspsubarrayleafnode.commands.on_command module

On command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspsubarrayLeafNode’s On() command.

On command on CspsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Csp Subarray device.

do(argin=None)

Method to invoke On command on Csp Subarray.

ska_tmc_cspsubarrayleafnode.commands.off_command module

Off command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CSPsubarrayLeafNode’s Off() command.

Off command on CSPsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Csp Subarray device.

do(argin=None)

Method to invoke Telescope Off command on Csp Subarray.

ska_tmc_cspsubarrayleafnode.commands.assign_resources_command module

AssignResouces command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.assign_resources_command.AssignResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspSubarayLeafNode’s AssignResources() command.

It accepts subarrayID and receptor ids in JSON string format and invokes AssignResources command on CSP Subarray.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke AssignResources command on CSP Subarray. :param argin:DevString. The string in JSON format. The JSON contains following values: subarray_id: integer dish: Mandatory JSON object consisting of receptor_ids: DevVarString The individual string should contain dish numbers in string format with preceding zeroes upto 3 digits. E.g. 0001, 0002. Example: { “interface”: “https: //schema.skao.int/ska-mid-csp-assignresources/2.0”, “subarray_id”: 1, “dish”: { “receptor_ids”: [ “0001”, “0002” ] } } Note: Enter the json string without spaces as an input. return: None

validate_json_argument(input_argin)

Validates the json argument

ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command module

ReleaseAllResources command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command.ReleaseAllResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given CSP Subarray Leaf Node.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke ReleaseAllResources command on CSP Subarray.

Parameters

argin – None.

Returns

None

Module contents