ska_tmc_mccsmasterleafnode.commands package

Submodules

ska_tmc_mccsmasterleafnode.commands.mccsmln_command module

Mccs Master Leaf Node Command module

class ska_tmc_mccsmasterleafnode.commands.mccs_mln_command.MccsMLNCommand(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCommand

A common command class for Mccs Master Leaf Node

init_adapter() → tuple

ska_tmc_mccsmasterleafnode.commands.off_command module

Off command class for MccsMasterLeafNode.

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

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s Off() command.

Off command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Mccs Controller device.

do()

Method to invoke Off command on Mccs Controller.

off(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None

ska_tmc_mccsmasterleafnode.commands.on_command module

On command class for MccsMasterLeafNode.

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

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s On() command.

On command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Mccs Controller device.

do()

Method to invoke On command on Mccs Controller.

on(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None

ska_tmc_mccsmasterleafnode.commands.standby_command module

Standby command class for MccsMasterLeafNode.

class ska_tmc_mccsmasterleafnode.commands.standby_command.Standby(*args: Any, **kwargs: Any)

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s Standby() command.

Standby command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It invokes Standby command on Mccs Controller device.

do()

Method to invoke Standby command on Mccs Controller.

standby(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

This is a long running method for Standby command, it executes do hook, invokes Standby command on MCCS Controller.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None

Module contents

Init module for Mccs Master Leaf Node

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

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s Off() command.

Off command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Mccs Controller device.

do()

Method to invoke Off command on Mccs Controller.

off(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None

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

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s On() command.

On command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Mccs Controller device.

do()

Method to invoke On command on Mccs Controller.

on(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None

class ska_tmc_mccsmasterleafnode.commands.Standby(*args: Any, **kwargs: Any)

Bases: MccsMLNCommand

A class for MccsMasterLeafNode’s Standby() command.

Standby command on MccsMasterLeafNode enables the telescope to perform further operations and observations. It invokes Standby command on Mccs Controller device.

do()

Method to invoke Standby command on Mccs Controller.

standby(logger: Logger, task_callback: Callable, task_abort_event: Optional[Event] = None) → None

This is a long running method for Standby command, it executes do hook, invokes Standby command on MCCS Controller.

Parameters:

• logger (logging.Logger) – logger

• task_callback (Callable, optional) – Update task state

• task_abort_event (Event, optional) – Check for abort, defaults to None