LCATtlmDb Class Reference

Database wrapper class for LCAT based telemetry. More...

Inheritance diagram for LCATtlmDb:

[legend]Collaboration diagram for LCATtlmDb:

[legend]List of all members.

Public Member Functions
def	__init__
	LCATtlmDb constructor.
def	__populateDicts
	Fill in the dictionaries used by getApidFromName and getNameFromApid.
def	getNames
	Retrieve a list of all telemetry mnemonic names.
def	getApids
	Retrieve a list of all telemetry apids.
def	getApidFromName
	Retrieve the apid from the telemetry mnemonic name.
def	getApidsFromNames
	Retrieve the apid list corresponding to the given telemetry mnemonic name list.
def	getNameFromApid
	Retrieve the name from the telemetry apid.
def	getDbModule
	Return the generated database module.
def	msgByName
	Return the message by name.
def	msgByValue
	Return the message by value.
def	msgIsSuccess
	Check if the message status is success.
def	decodeTelemetry
	Decode a telemetry packet and optionally dump the payloads.
def	getPayloadData
	Retrieve payload name and values.
def	msgOutToText
	a text string out of the message tuple
def	interpretMsgOut
	Interprets the LCMMSGOUTC telemetry packets and converts them to a tuple.

---

Detailed Description

Database wrapper class for LCAT based telemetry.

The purpose of this class is to provide helper methods for translating telemetry mnemonic to apid and vice versa.

Definition at line 36 of file LCATtlmDb.py.

---

Member Function Documentation

def __init__ (    self  )

LCATtlmDb constructor. Reimplemented from TlmDb. Definition at line 39 of file LCATtlmDb.py.

def __populateDicts (    self  )

Fill in the dictionaries used by getApidFromName and getNameFromApid. Definition at line 51 of file LCATtlmDb.py.

def decodeTelemetry (    self,   telemetry,   dump = False )

Decode a telemetry packet and optionally dump the payloads. Parameters: telemetry  Raw CCSDS packet dump  Boolean indicating whether to dump the telemetry payloads Returns: Decoded packet Definition at line 157 of file LCATtlmDb.py.

def getApidFromName (    self,   name )

Retrieve the apid from the telemetry mnemonic name. Parameters: name  Telemetry mnemonic name Returns: Telemetry apid Definition at line 80 of file LCATtlmDb.py.

def getApids (    self  )

Retrieve a list of all telemetry apids. Returns: A list containing all mnemonic apids Definition at line 73 of file LCATtlmDb.py.

def getApidsFromNames (    self,   nameList )

Retrieve the apid list corresponding to the given telemetry mnemonic name list. Parameters: nameList  Telemetry mnemonic name list Returns: Telemetry apid list Definition at line 93 of file LCATtlmDb.py.

def getDbModule (    self  )

Return the generated database module. Returns: Database module Definition at line 120 of file LCATtlmDb.py.

def getNameFromApid (    self,   apid )

Retrieve the name from the telemetry apid. Parameters: apid  Telemetry apid Returns: Telemetry mnemonic name. Definition at line 110 of file LCATtlmDb.py.

def getNames (    self  )

Retrieve a list of all telemetry mnemonic names. Returns: A list containing all mnemonic names Definition at line 66 of file LCATtlmDb.py.

def getPayloadData (    self,   pkt )

Retrieve payload name and values. Parameters: pkt  Decoded packet Returns: A list containing payload (name, value) tuples Definition at line 173 of file LCATtlmDb.py.

def interpretMsgOut (    self,   pkt )

Interprets the LCMMSGOUTC telemetry packets and converts them to a tuple. Parameters: pkt  Decoded packet Returns: Tuple containing (source, task, func, facil, name, text) Definition at line 192 of file LCATtlmDb.py.

def msgByName (    self,   name )

Return the message by name. Parameters: name  Message name Returns: Message text Definition at line 127 of file LCATtlmDb.py.

def msgByValue (    self,   value )

Return the message by value. Parameters: value  Message value Returns: Message tuple containing message code and description Definition at line 136 of file LCATtlmDb.py.

def msgIsSuccess (    self,   value )

Check if the message status is success. Parameters: value  Message value Returns: True if the value is success, False otherwise Definition at line 148 of file LCATtlmDb.py.

def msgOutToText (    self,   pkt )

a text string out of the message tuple Parameters: pkt  Decoded packet Returns: String containing a text version of the message tuple Definition at line 182 of file LCATtlmDb.py.

---

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

• LCATtlmDb.py

---