Transient buffer subpackage

This subpackage implements transient buffer functionality for MCCS.

class MccsTransientBuffer(*args: Any, **kwargs: Any)[source]

An implementation of a transient buffer Tango device for MCCS.

class InitCommand(*args: Any, **kwargs: Any)[source]

A class for MccsTransientBuffer’s Init command.

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

do(*args: Any, **kwargs: Any) → tuple[ska_control_model.ResultCode, str][source]

Initialise the attributes and properties of the MccsTransientBuffer.

Parameters:

  • args – positional args to the component manager method

  • kwargs – keyword args to the component manager method

Returns:

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

__init__(*args: Any, **kwargs: Any) → None[source]

Initialise this device object.

Parameters:

  • args – positional args to the init

  • kwargs – keyword args to the init

create_component_manager() → TransientBufferComponentManager[source]

Create and return a component manager for this device.

Returns:

a component manager for this device.

init_device() → None[source]

Initialise the device.

nStations() → int[source]

Return the number of stations.

Returns:

the number of stations

resamplingBits() → int[source]

Return the resampling bit depth.

Returns:

the resampling bit depth

stationId() → int[source]

Return the station id.

Returns:

the station id

stationIds() → list[str][source]

Return the station ids.

Returns:

the station ids

transientBufferJobId() → int[source]

Return the transient buffer job id.

Returns:

the transient buffer job id

transientFrequencyWindow() → list[float][source]

Return the transient frequency window.

Returns:

the transient frequency window

class TransientBuffer(*args: Any, **kwargs: Any)[source]

A placeholder for a transient buffer.

__init__(logger: Logger) → None[source]

Initialise a new instance.

Parameters:

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(*args: Any, **kwargs: Any)[source]

A component manager for a transient buffer.

__init__(logger: Logger, communication_state_callback: Callable[[ska_control_model.CommunicationStatus], None], component_state_callback: Callable[[...], None]) → None[source]

Initialise a new instance.

Parameters:

  • logger – the logger to be used by this object.

  • communication_state_callback – callback to be called when the status of the communications channel between the component manager and its component changes.

  • component_state_callback – callback to be called when the component state changes.

class TransientBufferHealthModel(*args: Any, **kwargs: Any)[source]

A health model for a transient buffer.

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