TelemetryEvent Class Reference

Helper class for handling telemetry. More...

List of all members.

Public Member Functions

def __init__
 TelemetryEvent constructor.
def __notification
 Callback for the command confirmation telemetry.
def wait
 Wait for telemetry.
def waitForPayload
 Wait for telemetry and return a list of payload values.
def enable
 Enable the callback.
def disable
 Disable the callback.
def isEnabled
 Find out if the telemetry event is enabled.


Detailed Description

Helper class for handling telemetry.

Definition at line 26 of file TelemetryEvent.py.


Member Function Documentation

def __init__   self,
  telemHandler,
  apidList,
  callback = None
 

TelemetryEvent constructor.

Parameters:
Telemetry handler instance
apidList List of apids
callbcak Callback method

Definition at line 28 of file TelemetryEvent.py.

def __notification   self,
  telemetry
 

Callback for the command confirmation telemetry.

Parameters:
telemetry Raw telemetry packet

Definition at line 42 of file TelemetryEvent.py.

def disable   self  ) 
 

Disable the callback.

Definition at line 112 of file TelemetryEvent.py.

def enable   self  ) 
 

Enable the callback.

Definition at line 106 of file TelemetryEvent.py.

def isEnabled   self  ) 
 

Find out if the telemetry event is enabled.

Returns:
Boolean indicating whether telemtry event is enabled or not

Definition at line 118 of file TelemetryEvent.py.

def wait   self,
  timeout = 10,
  quiet = False
 

Wait for telemetry.

Parameters:
timeout Wait timeout value
Returns:
False if the telemetry is not received within the given timeout. True if the telemetry is received.

Definition at line 53 of file TelemetryEvent.py.

def waitForPayload   self,
  payloads,
  timeout = 10,
  quiet = False
 

Wait for telemetry and return a list of payload values.

Parameters:
timeout Wait timeout value
payloads Payload names to query for
Returns:
A list of payload values or None if the telemetry is not received within the given timeout. If any of the payload names are invalid then None is returned for that payload

Definition at line 73 of file TelemetryEvent.py.


The documentation for this class was generated from the following file:
Generated on Thu Apr 27 20:53:08 2006 for LICOS L02-01-00 by doxygen 1.4.6-NO