All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ISerial.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2008 by Basler Vision Technologies
3 // Section: Vision Components
4 // Project: GenApi
5 // Author: Fritz Dierks
6 // $Header$
7 //
8 // License: This file is published under the license of the EMVA GenICam Standard Group.
9 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
10 // If for some reason you are missing this file please contact the EMVA or visit the website
11 // (http://www.genicam.org) for a full copy.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
14 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
17 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 // POSSIBILITY OF SUCH DAMAGE.
24 //-----------------------------------------------------------------------------
29 #ifndef CLPROTOCOL_ISERIAL_H
30 #define CLPROTOCOL_ISERIAL_H
31 
33 
34 //==============================================================================
35 // Exported Functions
36 //==============================================================================
37 
40 
42 class ISerial
43 {
44 public:
47  CLINT8* buffer,
48  CLUINT32* bufferSize,
52  CLUINT32 serialTimeOut
53  ) = 0;
54 
57  CLINT8* buffer,
58  CLUINT32* bufferSize,
59  CLUINT32 serialTimeOut
63  ) = 0;
64 
67  CLUINT32 *baudRates
68  ) = 0;
69 
71 
74  CLUINT32 baudRate
75  ) = 0;
76 };
78  // PublicInterfaces
80 
81 #endif // CLPROTOCOL_ISERIAL_H
ISerial::clGetSupportedBaudRates
virtual CLINT32 CLPROTOCOL clGetSupportedBaudRates(CLUINT32 *baudRates)=0
returns the valid baud rates of the current interface.
ISerial::clSerialWrite
virtual CLINT32 CLPROTOCOL clSerialWrite(CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut)=0
calls clSerialWrite as defined by the camera link standard
CLINT8
char CLINT8
Definition: ClSerialTypes.h:126
CLUINT32
unsigned int CLUINT32
Definition: ClSerialTypes.h:105
ISerial::clSetBaudRate
virtual CLINT32 CLPROTOCOL clSetBaudRate(CLUINT32 baudRate)=0
This function sets the baud rate for the serial port of the selected device.
CLINT32
int CLINT32
Definition: ClSerialTypes.h:100
ISerial::clSerialRead
virtual CLINT32 CLPROTOCOL clSerialRead(CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut)=0
calls clSerialRead as defined by the camera link standard
ClSerialTypes.h
types and constants as used by the Camera Link's API definition
ISerial
Abstract interface used by the CLProtocol driver to use a serial port.
Definition: ISerial.h:42
CLPROTOCOL
#define CLPROTOCOL
Definition: CLProtocol.h:73


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