CmdPkg Class Reference

Base class for package classes. More...

Inheritance diagram for CmdPkg:

[legend]List of all members.

Public Member Functions
def	__init__
	CmdPkg constructor.
def	__methodClosure
def	getPayloadValue
	Retrieve the payload value of a telecommand.
def	getPayloadDef
	Retrieve the payload definion.
def	getPayloadList
	Retrieve payload mnemonics.
def	getCmds
	Retrieve telecommand mnemonics.
def	getCmdObj
	Retrieve the telecommand object.
def	getCmdDb
	Retrieve the module containing command database classes.
def	getCmdCount
	Retrieve number of commands sent to the VSC since the start of the ScriptEngine.
def	getName
	Retrieve the package name.

---

Detailed Description

Base class for package classes.

There is a corresponding package class for each of the packages provided by the command and telemetry database. The telecommand mnemonics are grouped by these packages and LICOS syntax requires that they be specified when queueing telecommands to the VSC.

See this link for a list of packages and their telecommands.

Definition at line 51 of file cmdTlmDb.py.

---

Member Function Documentation

def __init__ (    self,   db )

CmdPkg constructor. Parameters: db  Generated module containing command and telemetry database classes. The constructor extracts the class corresponding to each telecommand mnemonic belonging to the package provided by the sub-class and converts it to a method member of that package subclass. For example if LHK is the sub-class then the three telecommand classes from the generated LCAT_cmd_db module are converted to member methods of the LHK class. Each member method contains named arguments where each argument is named after the corresponding telecommand payload. As with Python methods, the payload names are optional when passing the arguments to the telecommands. Reimplemented in DDT, FILE, LCI, LCM, LFS, LHK, LIM, LMC, LPA, LSM, LTC, MEM, and PBC. Definition at line 54 of file cmdTlmDb.py.

def __methodClosure (    self,   name )

Definition at line 91 of file cmdTlmDb.py.

def getCmdCount (    self  )

Retrieve number of commands sent to the VSC since the start of the ScriptEngine. Returns: Command count for this package since the start of the ScriptEngine Definition at line 221 of file cmdTlmDb.py.

def getCmdDb (    self  )

Retrieve the module containing command database classes. Returns: Tele-command database module Definition at line 214 of file cmdTlmDb.py.

def getCmdObj (    self,   cmd )

Retrieve the telecommand object. This method retrieves the telecommand object for the telecommand cmd. It can be used to access members not exposed by this class. Parameters: cmd  Telecommand mnemonic. Returns: An instance of a telecommand class Definition at line 201 of file cmdTlmDb.py.

def getCmds (    self  )

Retrieve telecommand mnemonics. This method retrieves all the telecommand mnemonics that are declared for this package. Returns: List of telecommand mnemonics. Definition at line 191 of file cmdTlmDb.py.

def getName (    self  )

Retrieve the package name. Returns: Package name Definition at line 229 of file cmdTlmDb.py.

def getPayloadDef (    self,   cmd,   mnem )

Retrieve the payload definion. This method retrieves the list containing the payload definition as defined in the telecommand class. Parameters: cmd  Telecommand mnemonic. mnem  Payload mnemonic. Returns: A list containing the payload declaration. Right now the items in this list used by LICOS are payload mnemonic (index 0) and brief (index 2). Definition at line 160 of file cmdTlmDb.py.

def getPayloadList (    self,   cmd )

Retrieve payload mnemonics. This method retrieves all the payload mnemonics that are needed for the telecommand cmd. Parameters: cmd  Telecommand mnemonic. Returns: List of payload mnemonics. Definition at line 179 of file cmdTlmDb.py.

def getPayloadValue (    self,   cmd,   mnem )

Retrieve the payload value of a telecommand. This method returns the payload value as set by the last call to the telecommand method. Parameters: cmd  Telecommand mnemonic. mnem  Payload mnemonic. Returns: Payload value Definition at line 147 of file cmdTlmDb.py.

---

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

• cmdTlmDb.py

---