All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ISerial Class Referenceabstract

Abstract interface used by the CLProtocol driver to use a serial port. More...

#include <ISerial.h>

Inheritance diagram for ISerial:

Public Member Functions

virtual CLINT32 CLPROTOCOL clGetSupportedBaudRates (CLUINT32 *baudRates)=0
 returns the valid baud rates of the current interface. More...
 
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 clSetBaudRate (CLUINT32 baudRate)=0
 This function sets the baud rate for the serial port of the selected device. More...
 

Detailed Description

Abstract interface used by the CLProtocol driver to use a serial port.

Definition at line 42 of file ISerial.h.

Member Function Documentation

◆ clGetSupportedBaudRates()

virtual CLINT32 CLPROTOCOL ISerial::clGetSupportedBaudRates ( CLUINT32 baudRates)
pure virtual

returns the valid baud rates of the current interface.

as described by serialRefPtr. See Table B-2 of the Camera Link docu for more information on constants.

Parameters
baudRatesBitfield that describes all supported baud rates of the serial port

Implemented in CLProtocol::CCLPort, and CLProtocol::CCLAllAdapter.

◆ clSerialRead()

virtual CLINT32 CLPROTOCOL ISerial::clSerialRead ( CLINT8 buffer,
CLUINT32 bufferSize,
CLUINT32  serialTimeOut 
)
pure virtual

calls clSerialRead as defined by the camera link standard

Parameters
bufferPoints 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.
bufferSizeThis is the number of bytes requested by the caller.
serialTimeOutIndicates the timeout in milliseconds.

Implemented in CLProtocol::CCLPort, and CLProtocol::CCLAllAdapter.

◆ clSerialWrite()

virtual CLINT32 CLPROTOCOL ISerial::clSerialWrite ( CLINT8 buffer,
CLUINT32 bufferSize,
CLUINT32  serialTimeOut 
)
pure virtual

calls clSerialWrite as defined by the camera link standard

Parameters
bufferContains data to write to the serial device.
bufferSizeContains 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.
serialTimeOutIndicates the timeout in milliseconds.

Implemented in CLProtocol::CCLPort, and CLProtocol::CCLAllAdapter.

◆ clSetBaudRate()

virtual CLINT32 CLPROTOCOL ISerial::clSetBaudRate ( CLUINT32  baudRate)
pure virtual

This function sets the baud rate for the serial port of the selected device.

values represented by the CL_BAUDRATE constants in table B-2. By default, the baud rate for serial communication is 9600.

Parameters
baudRateThe baud rate you want to use. This parameter expects the

Implemented in CLProtocol::CCLAllAdapter, and CLProtocol::CCLPort.


The documentation for this class was generated from the following file:


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:12