Wraps the CLAllSerial.dll.
More...
#include <CLAllAdapter.h>
Wraps the CLAllSerial.dll.
Definition at line 70 of file CLAllAdapter.h.
◆ CCLAllAdapter()
◆ ~CCLAllAdapter()
virtual CLProtocol::CCLAllAdapter::~CCLAllAdapter |
( |
| ) |
|
|
privatevirtual |
◆ CheckError() [1/2]
virtual void CLProtocol::CCLAllAdapter::CheckError |
( |
CLINT32 |
ErrorCode | ) |
|
|
virtual |
throws an exception if the ErrorCode describes an error
A CLErrException will be thrown.
- Parameters
-
ErrorCode | The error code to validate. If at he error is found, |
Implements CLProtocol::ISerialAdapter.
◆ CheckError() [2/2]
◆ clGetSupportedBaudRates()
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
-
baudRates | Bitfield that describes all supported baud rates of the serial port |
Implements ISerial.
◆ clSerialRead()
calls clSerialRead as defined by the camera link standard
- 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. |
Implements ISerial.
◆ clSerialWrite()
calls clSerialWrite as defined by the camera link standard
- 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. |
Implements ISerial.
◆ clSetBaudRate()
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
-
baudRate | The baud rate you want to use. This parameter expects the |
Implements ISerial.
◆ Destroy()
static void CLProtocol::CCLAllAdapter::Destroy |
( |
ISerialAdapter * |
pAdapter | ) |
|
|
static |
Destroy the factory and all its objects.
◆ GetPortIDs()
static void CLProtocol::CCLAllAdapter::GetPortIDs |
( |
GENICAM_NAMESPACE::gcstring_vector & |
TheVector | ) |
|
|
static |
used to copy the content of the SerialPort ma to a std::map
◆ GetSerialAdapter()
used to copy the content of the SerialPort ma to a std::map
◆ InternalGetPortMap()
static void CLProtocol::CCLAllAdapter::InternalGetPortMap |
( |
SerialPortMap & |
| ) |
|
|
staticprivate |
retrieves the list of port mapped by PortID
◆ SerialClose()
virtual void CLProtocol::CCLAllAdapter::SerialClose |
( |
void |
| ) |
|
|
virtual |
◆ SerialInit()
virtual CLINT32 CLProtocol::CCLAllAdapter::SerialInit |
( |
void |
| ) |
|
|
virtual |
◆ g_pSerialPortMap
◆ m_ClAlldllHandle
◆ m_clallproxy
CLAllProxy CLProtocol::CCLAllAdapter::m_clallproxy |
|
private |
◆ m_PreviousBaudRate
CLUINT32 CLProtocol::CCLAllAdapter::m_PreviousBaudRate |
|
private |
the previous baud rate as set via SetBaudRate; zero otherwise
Definition at line 150 of file CLAllAdapter.h.
◆ m_SerialIndex
CLUINT32 CLProtocol::CCLAllAdapter::m_SerialIndex |
|
private |
◆ m_SerialRef
hSerRef CLProtocol::CCLAllAdapter::m_SerialRef |
|
private |
The documentation for this class was generated from the following file: