The Methods, Events, and Properties documented here are refer to the Simple TINE Client ActiveX control 'Eqp.ocx'. Although the ActiveX control is language neutral, and can therefore be used in any container which supports ActiveX (such as Visual C++, LabView, HPVee, etc.) it is optimized for ease-of-use with Visual Basic.
This ActiveX control is modelled on its Visual Basic 3.0 predecessor, EQP.VBX and works fine. However, it's functionality is limited and rather primitive when compared to ACOP. In particular, the control consists of properties and events. There are no methods available. Functionality which would otherwise have been offered via methods of the control's instance is therefore made available through direct calls from tinecln32.dll (or tinecl16.dll).
It is suggested that you use the ACOP ActiveX control when programming with ActiveX is desired. On the other hand, if it is necessary to make use of Visual Basic 3.0 clients running on Windows 3.11, then you must use the equivalent .VBX control (EQP.VBX), in which case the documentation presented here becomes relevant.
Protected Member Functions | |
| void | FireReceive () |
| is the callback signal that incoming data (or status) has arrived. The caller must then check the link status paramter (EqpStatus) and obtain the incoming data into the address space of the application by calling one of the GETRPCDATA() family of calls. | |
| void | FireSend () |
| is the callforward signal that outgoing data are about to be sent. This event will be fired following the establishment of the link by setting Enable to True. The caller can then utilize the PUTRPCDATA() routine to pass the outgoing data to the TINE kernel, and to fix the data type and size of the outgoing data. | |
Protected Attributes | |
| CString | m_eqpProperty |
| Sets the requested Property to be used in the data link. | |
| CString | m_eqpName |
| Sets the requested Device Server Name to be used in the data link. This variable was once referred to as 'Equipment Name', hence the parameter name used here. You can use a fully qualified Device Server Name here, including the device context, device server, and device name as in. | |
| short | m_eqpSize |
| Sets the requested data array size to be used in the link execution. | |
| short | m_eqpFormat |
| Sets the data type format to be used in the data link. Note that in this simple interface, the assigned data type will be used for both input data (data sent to the server) and output data (data returned from the server). If the data set to be sent to the server has a different type or array size than the returned data, the caller must respond to the Send() event and make use of the PUTRPCDATA() routine. | |
| short | m_eqpStatus |
| Contains the current link status. When the receive event is fired, you should check to make sure this value is zero (success). If it is non-zero, it will contain a TINE completion code, which can be interpretted by using the routine RPCERR(). This paramter should also be checked following the establishment of the data link by setting Enabled to True. | |
| short | m_eqpPollMode |
| Sets the polling mode for the requested data link. This parameter is enumerated to contain only the allowed polling modes (CANCEL, SINGLE, REFRESH, POLL). | |
| short | m_eqpPollRate |
| Sets the polling rate in milliseconds for the data link in question. For single asynchronous calls, this parameter servers as a timeout. | |
| short | m_eqpNumber |
| Sets the requested Equipment Number to be used in the link execution. Making use of this parameter is equivalent to appending "\\#\<EqpNumber\>" to the EqpName parameter. This parameter is ignored if a device name appears in the EqpName paramter. | |
| BOOL | m_enabled |
| Enables the Client ActiveX control when set to TRUE. This action initialized the requested data link. | |
| void FireReceive | ( | ) | [inline, protected] |
is the callback signal that incoming data (or status) has arrived. The caller must then check the link status paramter (EqpStatus) and obtain the incoming data into the address space of the application by calling one of the GETRPCDATA() family of calls.
Visual Basic:
_Receive()
| void FireSend | ( | ) | [inline, protected] |
is the callforward signal that outgoing data are about to be sent. This event will be fired following the establishment of the link by setting Enable to True. The caller can then utilize the PUTRPCDATA() routine to pass the outgoing data to the TINE kernel, and to fix the data type and size of the outgoing data.
Visual Basic:
_Send()
BOOL m_eqpProperty [protected] |
Sets the requested Property to be used in the data link.
Visual Basic:
EqpProperty
BOOL m_eqpName [protected] |
Sets the requested Device Server Name to be used in the data link. This variable was once referred to as 'Equipment Name', hence the parameter name used here. You can use a fully qualified Device Server Name here, including the device context, device server, and device name as in.
Visual Basic:
EqpName
Eqp1.EqpName = "\\HERA\\HEPBPM\\WL167"
BOOL m_eqpSize [protected] |
Sets the requested data array size to be used in the link execution.
Visual Basic:
EqpSize
BOOL m_eqpFormat [protected] |
Sets the data type format to be used in the data link. Note that in this simple interface, the assigned data type will be used for both input data (data sent to the server) and output data (data returned from the server). If the data set to be sent to the server has a different type or array size than the returned data, the caller must respond to the Send() event and make use of the PUTRPCDATA() routine.
Visual Basic:
EqpFormat
BOOL m_eqpStatus [protected] |
Contains the current link status. When the receive event is fired, you should check to make sure this value is zero (success). If it is non-zero, it will contain a TINE completion code, which can be interpretted by using the routine RPCERR(). This paramter should also be checked following the establishment of the data link by setting Enabled to True.
Visual Basic:
EqpStatus
BOOL m_eqpPollMode [protected] |
Sets the polling mode for the requested data link. This parameter is enumerated to contain only the allowed polling modes (CANCEL, SINGLE, REFRESH, POLL).
Visual Basic:
EqpPollMode
BOOL m_eqpPollRate [protected] |
Sets the polling rate in milliseconds for the data link in question. For single asynchronous calls, this parameter servers as a timeout.
Visual Basic:
EqpPollRate
BOOL m_eqpNumber [protected] |
Sets the requested Equipment Number to be used in the link execution. Making use of this parameter is equivalent to appending "\\#\<EqpNumber\>" to the EqpName parameter. This parameter is ignored if a device name appears in the EqpName paramter.
Visual Basic:
EqpNumber
BOOL m_enabled [protected] |
Enables the Client ActiveX control when set to TRUE. This action initialized the requested data link.
Visual Basic:
Enabled
1.5.4