WebDevice class | QSYS API Reference Guide
Estimated reading time: 6 minutes
Defines the core behavior of the device handling the user interface for an interactive job and provides a base for derived classes.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| WebDevice(InteractiveJob) | Called from constructors in derived classes to initialize the WebDevice class. |
WebDevice(InteractiveJob)
Called from constructors in derived classes to initialize the WebDevice class.
WebDevice(InteractiveJob)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| InteractiveJob | job | The job owning the device. |
Properties
| Type | Name | Description |
|---|---|---|
| WebDisplayFile | ActiveDisplayFile | Gets the active display file performing the current operation on the device. |
| Boolean | DeviceIsOpen | Indicates that the device is open. |
Methods
| Signature | Description |
|---|---|
| Attach(String, WebDisplayFile) | Associates a named display file to this device for future sharing. Remembers the display file name for potential future sharing. |
| Attach(WebDisplayFile) | Associates a display file to this device. |
| close() | When overridden in a derived class, closes this device. |
| Detach(String) | Removes the association of a named display file with the device. |
| Detach(WebDisplayFile) | Removes the association of a display file with the device. |
| Dispose() | Calls the close method on the device. |
| GetSharedFile(String) | Gets a display file attached to the device. |
| open() | When overridden in a derived class, opens this device. |
| read() | When overridden in a derived class, waits for the user to enter new data on the device’s screen. |
| Read(WebDisplayFile) | Present a screen waiting for data to be ready and reads it. |
| RiseAbnormalEnd(String, String) | Marks the device as being in a job that is ending abnormally. |
| sendHostResult() | When ovveridden in a derived class, sends the host service results in the active display file and waits for new input. |
| SendHostResult(WebDisplayFile) | Send the host service results in a display file and waits for new input. |
| SignalDataReadyForProgram() | Signals the fact that data is now available to the program so it can continue execution. |
| SignalDataReadyForUser() | Signals the fact that data is now available to the user. |
| WaitForDataForProgram() | Waits for data to be available for the program. |
| WaitForDataForUser() | Waits for data to be available for the user. |
void Attach(string shareFileName, WebDisplayFile displayFile)
Associates a named display file to this device for future sharing. Remembers the display file name for potential future sharing.
void Attach(string shareFileName, WebDisplayFile displayFile)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | shareFileName | Shared file name to remember along with the display file. |
| WebDisplayFile | displayFile | The display file being associated to this device. |
void Attach(WebDisplayFile displayFile)
Associates a display file to this device.
void Attach(WebDisplayFile displayFile)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| WebDisplayFile | displayFile | The display file being associated to this device. |
void close()
When overridden in a derived class, closes this device.
void close()
void Detach(string shareFileName)
Removes the association of a named display file with the device.
void Detach(string shareFileName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | shareFileName | The name of the display file to be dissociated from the device. |
void Detach(WebDisplayFile displayFile)
Removes the association of a display file with the device.
void Detach(WebDisplayFile displayFile)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| WebDisplayFile | displayFile | The display file to be dissociated from the device. |
void Dispose()
Calls the close method on the device.
void Dispose()
WebDisplayFile GetSharedFile(string shareFileName)
Gets a display file attached to the device.
WebDisplayFile GetSharedFile(string shareFileName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | shareFileName | The shared name of display file being sought. |
Returns
| Type | Description |
|---|---|
| WebDisplayFile | The attached display file. Null if there is no display file with the name seeked. |
void open()
When overridden in a derived class, opens this device.
void open()
void read()
When overridden in a derived class, waits for the user to enter new data on the device’s screen.
void read()
void Read(WebDisplayFile dspFile)
Present a screen waiting for data to be ready and reads it.
void Read(WebDisplayFile dspFile)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| WebDisplayFile | dspFile | The display file to present to the user. It becomes the active display file on the device. |
void RiseAbnormalEnd(string abEndMessage, string abEndStack)
Marks the device as being in a job that is ending abnormally.
void RiseAbnormalEnd(string abEndMessage, string abEndStack)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | abEndMessage | A message text describing the abnormal termination. |
| String | abEndStack | The execution stack at the moment of failure. |
void sendHostResult()
When ovveridden in a derived class, sends the host service results in the active display file and waits for new input.
void sendHostResult()
void SendHostResult(WebDisplayFile dspFile)
Send the host service results in a display file and waits for new input.
void SendHostResult(WebDisplayFile dspFile)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| WebDisplayFile | dspFile | The display file with host results. It becomes the active display file on the device. |
void SignalDataReadyForProgram()
Signals the fact that data is now available to the program so it can continue execution.
void SignalDataReadyForProgram()
void SignalDataReadyForUser()
Signals the fact that data is now available to the user.
void SignalDataReadyForUser()
void WaitForDataForProgram()
Waits for data to be available for the program.
void WaitForDataForProgram()
void WaitForDataForUser()
Waits for data to be available for the user.
void WaitForDataForUser()