LCATcmdDb Class Reference

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

Inheritance diagram for LCATcmdDb:

[legend]Collaboration diagram for LCATcmdDb:

[legend]List of all members.

Public Member Functions
def	__init__
	LCATcmdDb constructor.
def	getCmdDict
	Return the command dictionary.
def	getDbModule
	Return the generated database module.
def	setCmdConfirmCallback
	Set the user script callback for the command confirmation telemetry.
def	getCmdConfirmCallback
	Get the current command confirmation callback.
def	confirmation
	Default callback for command confirmation telemetry.
def	quietConfirmation
	quiet callback for command confirmation telemetry
def	getConfirmationPacket
	Retrieve the last command confirmation packet received.
def	getConfirmationMsg
	Retrieve the status inside the last command confirmation packet received.
def	__confirmation
	Callback for the command confirmation telemetry.
def	waitForConfirmation
	Wait for the command confirmation packet.
def	waitForSuccessfulConfirmation
	Wait for successful command confirmation telemetry.
def	enableCmdConfirmTelem
def	disableCmdConfirmTelem
def	isCmdConfirmTelemEnabled

---

Detailed Description

Database wrapper class for LCAT based telecommands.

This class contains all telecommands based on the generated LCAT_cmd_db database. The telecommands are grouped by packages. A sample usage of queuing the telecommands to the VSC is shown below:

from   LICOS.lib.cmdTlmDb.LCATcmdDb import LCATcmdDb
.
.
lcat = LCATcmdDb(self.vsc)
mem = lcat.MEM
packet = mem.LMEMDUMPMEM(LMEMLATUNIT=1, LMEMTRANID=2, LMEMPAD=3,
                LMEMADDRESSHI=4, LMEMADDRESSLO=5, LMEMSIZEHI=6, LMEMSIZELO=7)

Definition at line 43 of file LCATcmdDb.py.

---

Member Function Documentation

def __confirmation (    self,   telemetry )

Callback for the command confirmation telemetry. Parameters: Raw  telemetry packet Definition at line 142 of file LCATcmdDb.py.

def __init__ (    self,   vsc )

LCATcmdDb constructor. Parameters: vsc  VPI_Proxy object. Reimplemented from CmdDb. Definition at line 46 of file LCATcmdDb.py.

def confirmation (    self,   telemetry )

Default callback for command confirmation telemetry. Parameters: Raw  telemetry packet Definition at line 103 of file LCATcmdDb.py.

def disableCmdConfirmTelem (    self  )

Definition at line 186 of file LCATcmdDb.py.

def enableCmdConfirmTelem (    self  )

Definition at line 183 of file LCATcmdDb.py.

def getCmdConfirmCallback (    self  )

Get the current command confirmation callback. Returns: Command confirmation callback. Definition at line 96 of file LCATcmdDb.py.

def getCmdDict (    self  )

Return the command dictionary. Returns: Command dictionary Definition at line 75 of file LCATcmdDb.py.

def getConfirmationMsg (    self  )

Retrieve the status inside the last command confirmation packet received. Definition at line 132 of file LCATcmdDb.py.

def getConfirmationPacket (    self  )

Retrieve the last command confirmation packet received. Definition at line 126 of file LCATcmdDb.py.

def getDbModule (    self  )

Return the generated database module. Returns: Database module Definition at line 82 of file LCATcmdDb.py.

def isCmdConfirmTelemEnabled (    self  )

Definition at line 189 of file LCATcmdDb.py.

def quietConfirmation (    self,   telemetry )

quiet callback for command confirmation telemetry Parameters: Raw  telemetry packet Definition at line 119 of file LCATcmdDb.py.

def setCmdConfirmCallback (    self,   callback )

Set the user script callback for the command confirmation telemetry. Parameters: callback  Callback method Definition at line 89 of file LCATcmdDb.py.

def waitForConfirmation (    self,   timeout = 10,   quiet = False )

Wait for the command confirmation packet. Parameters: timeout  Amount of time to wait for the command confirmation packet Returns: True if a command confirmation packet is received. False if no command confirmation packet is received before the timeout. Definition at line 151 of file LCATcmdDb.py.

def waitForSuccessfulConfirmation (    self,   timeout = 10,   quiet = False )

Wait for successful command confirmation telemetry. Parameters: timeout  Number of seconds to wait for the confirmation. Returns: True if command confirmation was successful, False otherwise. Definition at line 168 of file LCATcmdDb.py.

---

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

• LCATcmdDb.py

---