Capability

SKACapability

Capability handling device

Tango Device Class

class ska_tango_base.SKACapability(*args: Any, **kwargs: Any)

A Subarray handling device. It exposes the instances of configured capabilities.

init_command_objects()

Sets up the command objects

class InitCommand(target, state_model, logger=None)

Create a new InitCommand

Parameters

• target (object) – the object that this command acts upon; for example, the SKASubarray device for which this class implements the command

• state_model (DeviceStateModel) – the state model that this command uses to check that it is allowed to run, and that it drives with actions.

• logger (a logger that implements the standard library logger interface) – the logger to be used by this Command. If not provided, then a default module logger will be used.

do()

Stateless hook for device initialisation.

Returns

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

Return type

(ResultCode, str)

CapType = tango.server.device_property(dtype=str)

CapID = tango.server.device_property(dtype=str)

subID = tango.server.device_property(dtype=str)

activationTime = tango.server.attribute(dtype=double, unit=s, standard_unit=s, display_unit=s, doc=Time of activation in seconds since Unix epoch.)

Device attribute.

configuredInstances = tango.server.attribute(dtype=uint16, doc=Number of instances of this Capability Type currently in use on this subarray.)

Device attribute.

usedComponents = tango.server.attribute(dtype=('str',), max_dim_x=100, doc=A list of components with no. of instances in use on this Capability.)

Device attribute.

always_executed_hook()

Method that is always executed before any device command gets executed.

Returns

None

delete_device()

Method to cleanup when device is stopped.

Returns

None

read_activationTime()

Reads time of activation since Unix epoch. :return: Activation time in seconds

read_configuredInstances()

Reads the number of instances of a capability in the subarray :return: The number of configured instances of a capability in a subarray

read_usedComponents()

Reads the list of components with no. of instances in use on this Capability :return: The number of components currently in use.

class ConfigureInstancesCommand(target, state_model, logger=None)

A class for the SKALoggerDevice’s SetLoggingLevel() command.

Creates a new BaseCommand object for a device.

Parameters

• state_model (SKABaseClassStateModel or a subclass of same) – the state model that this command uses, for example to raise a fatal error if the command errors out.

• target (object) – the object that this base command acts upon. For example, the device that this BaseCommand implements the command for.

• logger (a logger that implements the standard library logger interface) – the logger to be used by this Command. If not provided, then a default module logger will be used.

do(argin)

Stateless hook for ConfigureInstances()) command functionality.

Returns

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

Return type

(ResultCode, str)

ConfigureInstances(argin)

This function indicates how many number of instances of the current capacity should to be configured.

To modify behaviour for this command, modify the do() method of the command class.

Parameters

argin – Number of instances to configure

Returns

None.