rtCommon.webDisplayInterface

WebDisplayInterface is a client interface (i.e. for the experiment script running in the cloud) that provides calls that affect what is displayed in the users web browser. It is also used internally within projectServer for setting log and error messages within the web browser.

Module Contents

Classes

WebDisplayInterface

class rtCommon.webDisplayInterface.WebDisplayInterface(ioLoopInst=None)
userLog(self, logStr)

Set a log message in the user log area of the web page

sessionLog(self, logStr)

Set a log message in the session log area of the web page

debugLog(self, logStr)

Set a log message in the debug log area of the web page

setUserError(self, errStr)

Set an error message in the error display area of the web page

setDebugError(self, errStr)

Set an error message in the debug display area of the web page

sendRunStatus(self, statusStr)

Indicate run status in the web page

sendUploadStatus(self, fileStr)
sendConfig(self, config, filename='')

Send the project configurations to the web page

sendPreviousDataPoints(self)

Send previously plotted data points to the web page

plotDataPoint(self, runId, trId, value)

Add a new data point to the web page plots

clearAllPlots(self)

Clear all data plots in the web page

clearRunPlot(self, runId)

Clear the data plot for the specfied run

getPreviousDataPoints(self)

Local command to retrieve previously plotted points (doesn’t send to web page)

sendConnStatus(self)

Send the number of data and subject connections to the web page

wsConnCallback(self, endpoint, cmd)

Callback function for whenever a new websocket connection is established. Will track the number of connections in order to provide the connection status on the web page interface.

_addResultValue(self, runId, trId, value)

Track classification result values, used to plot the results in the web browser.

_sendMessageToWeb(self, msg)

Helper function used by the other methods to send a message to the web page