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
- class rtCommon.webDisplayInterface.WebDisplayInterface(ioLoopInst=None)
- userLog(logStr)
Set a log message in the user log area of the web page
- sessionLog(logStr)
Set a log message in the session log area of the web page
- debugLog(logStr)
Set a log message in the debug log area of the web page
- setUserError(errStr)
Set an error message in the error display area of the web page
- setDebugError(errStr)
Set an error message in the debug display area of the web page
- sendRunStatus(statusStr)
Indicate run status in the web page
- sendUploadStatus(fileStr)
- sendConfig(config, filename='')
Send the project configurations to the web page
- sendPreviousDataPoints()
Send previously plotted data points to the web page
- plotDataPoint(runId, trId, value)
Add a new data point to the web page plots
- clearAllPlots()
Clear all data plots in the web page
- clearRunPlot(runId)
Clear the data plot for the specfied run
- getPreviousDataPoints()
Local command to retrieve previously plotted points (doesn’t send to web page)
- sendConnStatus()
Send the number of data and subject connections to the web page
- wsConnCallback(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(runId, trId, value)
Track classification result values, used to plot the results in the web browser.
- _sendMessageToWeb(msg)
Helper function used by the other methods to send a message to the web page