ScriptEngineCommon Class Reference

Common class for providing a run control helper functions. More...

List of all members.

Public Member Functions
def	__init__
	ScriptEngineCommon constructor.
def	connectVSC
	Connect to the Script Engine Proxy.
def	getLCATcmd
	Retrieve the LCAT command database wrapper instance.
def	getLCATtlm
	Retrieve the LCAT telemetry database wrapper instance.
def	addLatWatchItems
	Add LAT related watch items to the status panel.
def	connectCVT
	Connect to the current value table.
def	populateTlmDb
def	initialize
	Initialization.
def	readScriptOpts
	Read the script options file.
def	getScriptOpts
	Retrieve the options for script scriptName.
def	__usage
	Usage.
def	connect
	Connect to the servers.
def	disconnect
	Disconnect from the servers.
def	elogWebsite
	Launch the web browser and point it to the E-Logbook site.
def	EBFdistribution
	Initialize the data distribution server.
def	setLoggingLevel
	Set the logging level.
def	startLogger
	Start the logger.
def	stopRunLog
	Stop the file log.fileHdlr Log file handler.
def	startRunLog
	Start the file log.fileName File name for the log file.
def	startLcmLog
def	stopLcmLog
def	__processMsgOut
def	options
	Retrieve the command line options.
def	prefMan
	Retrieve the preferences manager.
def	preferences
	Retrieve the preferences.
def	prefGUI
	Retrieve the preferences GUI.
def	getMSGLogger
	Retrieve the message logger GUI.
def	getDDS
	Retrieve the data distributor.
def	getCmdCli
	Retrieve the Script Engine proxy.
def	getTlmDb
	Retrieve the telemetry database object.
def	getDBN
	Retrieve the DBN node.
def	getSecurityMan
	Retrieve the security manager.
def	getQtApp
	Retrieve the Qt app.
def	setGUI
	Set the GUI.
def	getGUI
	Retrieve the GUI.
def	getLoginId
	Returns the login id for the last successful login.
def	getErrorLogCount
	Retrueve the error log count for the current run.
def	incrementErrorLogCount
	Increment the error log count.
def	resetErrorLogCount
	Reset the error log count.
def	showLogin
	Handle login.
def	configureHardware
	Configure the hardware based on the user selection.
def	getLatConfigId
def	getDiagHandler
	Retrieve the LAT/VSC diagnostic telemetry handler.
def	getTelemHandler
	Retrieve the LAT/VSC telemetry handler.
def	getPidsHandler
	Retrieve the pids telemetry handler.
Private Attributes
	__tlmDb
	__lcmFile
	__lcmLock

---

Detailed Description

Common class for providing a run control helper functions.

Definition at line 148 of file ScriptEngineCommon.py.

---

Member Function Documentation

def __init__ (    self  )

ScriptEngineCommon constructor. Definition at line 150 of file ScriptEngineCommon.py.

def __processMsgOut (    self,   telem )

Definition at line 620 of file ScriptEngineCommon.py.

def __usage (    self  )

Usage. Definition at line 402 of file ScriptEngineCommon.py.

def addLatWatchItems (    self  )

Add LAT related watch items to the status panel. Definition at line 279 of file ScriptEngineCommon.py.

def configureHardware (    self  )

Configure the hardware based on the user selection. Returns: Whether the user cancelled or confirmed the selection Definition at line 781 of file ScriptEngineCommon.py.

def connect (    self  )

Connect to the servers. Definition at line 442 of file ScriptEngineCommon.py.

def connectCVT (    self  )

Connect to the current value table. Definition at line 295 of file ScriptEngineCommon.py.

def connectVSC (    self  )

Connect to the Script Engine Proxy. Definition at line 199 of file ScriptEngineCommon.py.

def disconnect (    self  )

Disconnect from the servers. Definition at line 453 of file ScriptEngineCommon.py.

def EBFdistribution (    self  )

Initialize the data distribution server. Definition at line 467 of file ScriptEngineCommon.py.

def elogWebsite (    self  )

Launch the web browser and point it to the E-Logbook site. Definition at line 460 of file ScriptEngineCommon.py.

def getCmdCli (    self  )

Retrieve the Script Engine proxy. Returns: seProxy instance Definition at line 674 of file ScriptEngineCommon.py.

def getDBN (    self  )

Retrieve the DBN node. Returns: GDBN instance. Definition at line 692 of file ScriptEngineCommon.py.

def getDDS (    self  )

Retrieve the data distributor. Returns: DataDistributorServer instance Definition at line 667 of file ScriptEngineCommon.py.

def getDiagHandler (    self  )

Retrieve the LAT/VSC diagnostic telemetry handler. Returns: seTelemetryHandler instance Definition at line 807 of file ScriptEngineCommon.py.

def getErrorLogCount (    self  )

Retrueve the error log count for the current run. Returns: Error log count Definition at line 734 of file ScriptEngineCommon.py.

def getGUI (    self  )

Retrieve the GUI. Returns: The GUI widget Definition at line 720 of file ScriptEngineCommon.py.

def getLatConfigId (    self  )

Definition at line 799 of file ScriptEngineCommon.py.

def getLCATcmd (    self  )

Retrieve the LCAT command database wrapper instance. Returns: LCATcmdDb instance Definition at line 265 of file ScriptEngineCommon.py.

def getLCATtlm (    self  )

Retrieve the LCAT telemetry database wrapper instance. Returns: LCATtlmDb instance Definition at line 272 of file ScriptEngineCommon.py.

def getLoginId (    self  )

Returns the login id for the last successful login. Returns: User's login id Definition at line 727 of file ScriptEngineCommon.py.

def getMSGLogger (    self  )

Retrieve the message logger GUI. Returns: MSGLogGUIImpl instance Definition at line 660 of file ScriptEngineCommon.py.

def getPidsHandler (    self  )

Retrieve the pids telemetry handler. Returns: sePidsHandler instance Definition at line 821 of file ScriptEngineCommon.py.

def getQtApp (    self  )

Retrieve the Qt app. Returns: QApplication instance Definition at line 706 of file ScriptEngineCommon.py.

def getScriptOpts (    self,   scriptName )

Retrieve the options for script scriptName. Parameters: scriptName  Name of the script Returns: Dictionary of options for the script or None. Definition at line 390 of file ScriptEngineCommon.py.

def getSecurityMan (    self  )

Retrieve the security manager. Returns: rcSecurityMan instance Definition at line 699 of file ScriptEngineCommon.py.

def getTelemHandler (    self  )

Retrieve the LAT/VSC telemetry handler. Returns: seTelemetryHandler instance Definition at line 814 of file ScriptEngineCommon.py.

def getTlmDb (    self  )

Retrieve the telemetry database object. This object contains EGU conversions for LAT housekeeping telemetry. Returns: An ISOC.TlmUtils.TlmRdbInterface.TlmRdbDb instance Definition at line 683 of file ScriptEngineCommon.py.

def incrementErrorLogCount (    self  )

Increment the error log count. Definition at line 741 of file ScriptEngineCommon.py.

def initialize (    self,   startup = False )

Initialization. Parameters: startup  Are we initializing for the first time? Definition at line 328 of file ScriptEngineCommon.py.

def options (    self  )

Retrieve the command line options. Returns: Command line options. Definition at line 630 of file ScriptEngineCommon.py.

def populateTlmDb (    self  )

Definition at line 306 of file ScriptEngineCommon.py.

def preferences (    self  )

Retrieve the preferences. Returns: Preferences instance Definition at line 644 of file ScriptEngineCommon.py.

def prefGUI (    self  )

Retrieve the preferences GUI. Returns: rcPreferencesGUIImpl instance Definition at line 651 of file ScriptEngineCommon.py.

def prefMan (    self  )

Retrieve the preferences manager. Returns: rcPreferencesManager instance Definition at line 637 of file ScriptEngineCommon.py.

def readScriptOpts (    self,   scrOptsFile )

Read the script options file. The script options file is used to debug a script without issuing a LICOS release. It should not be used in 'for credit' runs since it may change the behavior of the script. The script options file is a configuration file parsable by ConfigParser. Each section contains the script name. Under each section the options for that script and their values are listed. The options used for a given script are recorded in the run report. Parameters: scrOptsFile  File containing the script options Returns: Dictionary containing the script options Definition at line 362 of file ScriptEngineCommon.py.

def resetErrorLogCount (    self  )

Reset the error log count. Definition at line 747 of file ScriptEngineCommon.py.

def setGUI (    self,   gui )

Set the GUI. Parameters: gui  The GUI widget Definition at line 713 of file ScriptEngineCommon.py.

def setLoggingLevel (    self,   logLevel = None )

Set the logging level. Parameters: logLevel  Log level. Can be one of "DEBUG","INFO","WARN","ERROR","CRITICAL" Definition at line 508 of file ScriptEngineCommon.py.

def showLogin (    self,   parent )

Handle login. Parameters: parent  Parent GUI Returns: Authentication result, 0=Successful login, -1=Authentication failed, else password database is not accessible. Definition at line 753 of file ScriptEngineCommon.py.

def startLcmLog (    self,   filename )

Definition at line 605 of file ScriptEngineCommon.py.

def startLogger (    self,   startup = True )

Start the logger. Parameters: startup  Are we calling startLogger from startup? Definition at line 526 of file ScriptEngineCommon.py.

def startRunLog (    self,   fileName )

Start the file log.fileName File name for the log file. Definition at line 594 of file ScriptEngineCommon.py.

def stopLcmLog (    self  )

Definition at line 613 of file ScriptEngineCommon.py.

def stopRunLog (    self,   fileHdlr )

Stop the file log.fileHdlr Log file handler. Definition at line 582 of file ScriptEngineCommon.py.

---

Member Data Documentation

__lcmFile [private]

Definition at line 606 of file ScriptEngineCommon.py.

__lcmLock [private]

Definition at line 611 of file ScriptEngineCommon.py.

__tlmDb [private]

Definition at line 320 of file ScriptEngineCommon.py.

---

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

• ScriptEngineCommon.py

---