Abstract interface used by the CLProtocol driver to use a serial port.
Inherited by CCLPort, and ISerialAdapter.
|
| virtual CLINT32 CLPROTOCOL | clSerialRead (CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut)=0 |
| | calls clSerialRead as defined by the camera link standard More...
|
| |
| virtual CLINT32 CLPROTOCOL | clSerialWrite (CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut)=0 |
| | calls clSerialWrite as defined by the camera link standard More...
|
| |
| virtual CLINT32 CLPROTOCOL | clGetSupportedBaudRates (CLUINT32 *baudRates)=0 |
| | returns the valid baud rates of the current interface. More...
|
| |
| virtual CLINT32 CLPROTOCOL | clSetBaudRate (CLUINT32 baudRate)=0 |
| | This function sets the baud rate for the serial port of the selected device. More...
|
| |
◆ clSerialRead()
| virtual CLINT32 CLPROTOCOL clSerialRead |
( |
CLINT8 * |
buffer, |
|
|
CLUINT32 * |
bufferSize, |
|
|
CLUINT32 |
serialTimeOut |
|
) |
| |
|
pure virtual |
- Parameters
-
| buffer | Points to a user-allocated buffer. Upon a successful call, buffer contains the data read from the serial device. Upon failure, this buffer is not affected. Caller should ensure that buffer is at least numBytes in size. |
| bufferSize | This is the number of bytes requested by the caller. |
| serialTimeOut | Indicates the timeout in milliseconds. |
Implemented in CCLPort.
◆ clSerialWrite()
| virtual CLINT32 CLPROTOCOL clSerialWrite |
( |
CLINT8 * |
buffer, |
|
|
CLUINT32 * |
bufferSize, |
|
|
CLUINT32 |
serialTimeOut |
|
) |
| |
|
pure virtual |
- Parameters
-
| buffer | Contains data to write to the serial device. |
| bufferSize | Contains the buffer size indicating the number of bytes to be written. Upon a successful call, bufferSize contains the number of bytes written to the serial device. |
| serialTimeOut | Indicates the timeout in milliseconds. |
Implemented in CCLPort.
◆ clGetSupportedBaudRates()
| virtual CLINT32 CLPROTOCOL clGetSupportedBaudRates |
( |
CLUINT32 * |
baudRates | ) |
|
|
pure virtual |
as described by serialRefPtr. See Table B-2 of the Camera Link docu for more information on constants.
- Parameters
-
| baudRates | Bitfield that describes all supported baud rates of the serial port |
Implemented in CCLPort.
◆ clSetBaudRate()
| virtual CLINT32 CLPROTOCOL clSetBaudRate |
( |
CLUINT32 |
baudRate | ) |
|
|
pure virtual |
values represented by the CL_BAUDRATE constants in table B-2. By default, the baud rate for serial communication is 9600.
- Parameters
-
| baudRate | The baud rate you want to use. This parameter expects the |
