Mercury2 Hardware Manager  1.0dev
The hardware manager component of the Mercury2 ground station suite.
 All Classes Namespaces Functions Variables Pages
hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer Class Reference

A push producer that is responsible for moderating pipeline telemetry production. More...

Inheritance diagram for hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer:

Public Member Functions

def __init__
 Sets up the pipeline telemetry producer. More...
 
def pauseProducing
 Called when the pipeline should pause writing its telemetry to its active session. More...
 
def resumeProducing
 Called when the pipeline should resume writing its telemetry data to its active session. More...
 
def stopProducing
 Called when the pipeline should stop writing its telemetry data to its active session. More...
 

Public Attributes

 pipeline
 

Detailed Description

A push producer that is responsible for moderating pipeline telemetry production.

This class defines an IPushProducer that is responsible for regulating that pipeline's telemetry output stream as dictated by the telemetry protocols currently attached to the pipeline's active session.

Constructor & Destructor Documentation

def hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer.__init__ (   self,
  pipeline 
)

Sets up the pipeline telemetry producer.

Parameters
pipelineThe Pipeline whose telemetry stream this producer should regulate.

Member Function Documentation

def hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer.pauseProducing (   self)

Called when the pipeline should pause writing its telemetry to its active session.

This method is called when one of the pipeline's associated telemetry protocols determines that it can no longer receive any input. It simply sets a flag that causes the pipeline to not route its telemetry to its session. The data is still available to any services or devices that may require it. Because the pipeline's telemetry data is tied to a specific time, old telemetry typically doesn't need to reach the end user. This differs from the pipeline's data stream in that all of the pipeline's data stream must always reach the end user.

def hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer.resumeProducing (   self)

Called when the pipeline should resume writing its telemetry data to its active session.

This method is called by a telemetry protocol currently associated with the pipeline when it is ready to receive more telemetry from the pipeline. It simply sets a flag that indicates to the pipeline that it should continue to pass its telemetry data to its session.

def hwm.hardware.pipelines.pipeline.PipelineTelemetryProducer.stopProducing (   self)

Called when the pipeline should stop writing its telemetry data to its active session.

This method is called by a telemetry protocol currently associated with the pipeline when it doesn't want to receive any more telemetry data. Because telemetry is produced as long as a session is active on a pipeline, and because additional telemetry protocols may still be interested in the data, this method has no effect.


The documentation for this class was generated from the following file: