Transient buffer subpackage

This subpackage implements transient buffer functionality for MCCS.

class MccsTransientBuffer(*args, **kwargs)

An implementation of a transient buffer Tango device for MCCS.

class InitCommand(*args, **kwargs)

A class for MccsTransientBuffer’s Init command.

The do() method below is called upon MccsTransientBuffer’s initialisation.

do(*args, **kwargs)

Initialise the attributes and properties of the MccsTransientBuffer.

Parameters:

  • args (Any) – positional args to the component manager method

  • kwargs (Any) – keyword args to the component manager method

Return type:

tuple[ResultCode, str]

Returns:

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

__init__(*args, **kwargs)

Initialise this device object.

Parameters:

  • args (Any) – positional args to the init

  • kwargs (Any) – keyword args to the init

create_component_manager()

Create and return a component manager for this device.

Return type:

TransientBufferComponentManager

Returns:

a component manager for this device.

init_device()

Initialise the device.

This is overridden here to change the Tango serialisation model.

Return type:

None

nStations()

Return the number of stations.

Return type:

int

Returns:

the number of stations

resamplingBits()

Return the resampling bit depth.

Return type:

int

Returns:

the resampling bit depth

stationId()

Return the station id.

Return type:

int

Returns:

the station id

stationIds()

Return the station ids.

Return type:

list[str]

Returns:

the station ids

transientBufferJobId()

Return the transient buffer job id.

Return type:

int

Returns:

the transient buffer job id

transientFrequencyWindow()

Return the transient frequency window.

Return type:

list[float]

Returns:

the transient frequency window

class TransientBuffer(logger)

A placeholder for a transient buffer.

__init__(logger)

Initialise a new instance.

Parameters:

logger (Logger) – a logger for this component to use

property n_stations: int

Return the number of stations.

Returns:

the number of stations

property resampling_bits: int

Return the resampling bit depth.

Returns:

the resampling bit depth.

property station_id: str

Return the station id.

Returns:

the station id.

property station_ids: list[str]

Return the station ids.

Returns:

the station ids.

property transient_buffer_job_id: str

Return the transient buffer job id.

Returns:

the transient buffer job id.

property transient_frequency_window: tuple[float]

Return the transient frequency window.

Returns:

the transient frequency window

class TransientBufferComponentManager(logger, communication_state_callback, component_state_callback)

A component manager for a transient buffer.

__init__(logger, communication_state_callback, component_state_callback)

Initialise a new instance.

Parameters:

  • logger (Logger) – the logger to be used by this object.

  • communication_state_callback (Callable[[CommunicationStatus], None]) – callback to be called when the status of the communications channel between the component manager and its component changes.

  • component_state_callback (Callable[..., None]) – callback to be called when the component state changes.

class TransientBufferHealthModel(*args, **kwargs)

A health model for a transient buffer.

At present this uses the base health model; this is a placeholder for a future, better implementation.