lsst.sims.ocs.sal.sal_manager module

class lsst.sims.ocs.sal.sal_manager.SalManager(debug_level=0)

Bases: future.types.newobject.newobject

Handle SAL interactions.

This class is responsible for most of the interactions with the SAL for DDS communications.

Initialize the class.

Parameters:debug_level (int) – The debugging level of the SALPY sub-system manager.

finalize()

Perform finalization steps.

This function shuts down the Scheduler SAL manager.

get_topic(topic_short_name)

Get the given topic.

This function retrieves the associated data structure for the topic.

Parameters:topic_short_name (str) – The part of the topic name minus the scheduler prefix. Returns:SALPY_scheduler.<topic_short_name>C – The telemetry data structure associated with the topic.

initialize()

Perform initialization steps.

This function handles creation of the Scheduler SAL manager and sets the debugging level.

put(topic_obj)

Publish the topic.

This function does the actual work of publishing the given telemetry topic data structure. The type is inferred from the topic object itself.

Parameters:topic_obj (SALPY_scheduler.<topic_obj>) – The telemetry topic data structure.

set_publish_topic(topic_short_name)

Set the given topic for publishing.

This function handles the topic publishing setup include retrieval of the associated data structure.

Parameters:topic_short_name (str) – The part of the topic name minus the scheduler prefix. Returns:SALPY_scheduler.<topic_short_name>C – The telemetry data structure associated with the published topic.

set_subscribe_topic(topic_short_name)

Set the given topic for subscribing.

This function handles the topic subscribing setup include retrieval of the associated data structure.

Parameters:topic_short_name (str) – The part of the topic name minus the scheduler prefix. Returns:SALPY_scheduler.<topic_short_name>C – The telemetry data structure associated with the subscribed topic.