rcSuite Class Reference

List of all members.

Public Member Functions
	__init__ (msg, suite, module)
	beforeSetupSuite (suite)
	afterSetupSuite (suite)
	beforeStartSuite (suite)
	afterStartSuite (suite)
	beforeStopSuite (suite)
	afterStopSuite (suite)
	__init__ (logLevel="INFO")
	launch (suiteClass, user, callbacks=None)
	doStopRun ()
	preferences ()
	common ()
	__init__ (gui, userId, debug)
	setupSuite ()
	rcPauseSuite ()
	pauseSuite ()
	rcSetupSuite ()
	rcStartSuite (spawn=1)
	stopSuite ()
	rcStopSuite ()
	scriptRun (module, context={})
	resetSuiteScript ()
	setCmdCli (cmdCli)
	setEvtCli (evtCli)
	getEvtCli ()
	isSuiteScriptAborted ()
	getScriptSequence ()
	getScriptState ()
	Return the state of the suite script.
	getAppState ()
	Return the state of the current script.
	getApp ()
	Return the instance of current script.
	getSuite ()
	Get the parent suite name of this suite.
	setSuite (name)
	Set the parent suite name of this suite.
	getSuiteInstance ()
	Return the parent suite instance that this suite is a part of.
	setSuiteInstance (suiteInst)
	Set the parent suite instance for this suite.
	setSessionVar (key, value)
	Set a session variable.
	getSessionVar (key)
	readSchema (scmCfgFile)
	applyConfig (seq=None, gxbrd=None)
	stopRequested ()
	clearStopRequested ()
	isPaused ()
	isRunning ()
	getName ()
	startSuite ()

---

Detailed Description

Definition at line 11 of file rcSuite.py.

---

Member Function Documentation

getApp (   )

Return the instance of current script. Returns the instance for the suite script or nested suite that is currently executing. Returns: userApplication or userSuite instance.

getAppState (   )

Return the state of the current script. Returns: State of the current script

getScriptState (   )

Return the state of the suite script. Currently there are two states. 'RESET' or 'RUNNING'. If rcSetupSuite or rcStopSuite has completed execution then the state will be 'RESET'. If rcStartSuite started execution then the state will be 'RUNNING'. Returns: 'RESET' or 'RUNNING'

getSessionVar (  key   )

Retrieve the values of the session variable indicated by key. Returns: Session variable value

getSuite (   )

Get the parent suite name of this suite. Returns: Parent suite name or None.

getSuiteInstance (   )

Return the parent suite instance that this suite is a part of. Returns: Parent suite instance.

pauseSuite (   )

Override this method to do custom processing before the currently running application is paused. Pause can be rejected by not returning None

rcSetupSuite (   )

This method can be called from either RunControlMain or from another suite.

setSessionVar (  key  , value  )

Set a session variable. Do not use variable names beginning with the underscore ('_') character since these are reserved for RunControl

setSuite (  name   )

Set the parent suite name of this suite. Parameters: name  Parent suite name

setSuiteInstance (  suiteInst   )

Set the parent suite instance for this suite. Parameters: suiteInst  Parent suite instance.

setupSuite (   )

Override this method to do custom processing before the suite is started and/or to return a custom schema file

stopSuite (   )

Override this method to do custom processing before the suite is terminated

---

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

• rcSuite.py

---