OceanDirect  2.4.0
OceanDirect C++/C API
SerialPortAPI.h
1 /*****************************************************
2  * @file SerialPortAPI.h
3  * @date April 2021
4  * @author Ocean Insight, Inc.
5  *
6  * This is an interface to OceanDirect that allows
7  * the user to read and write serial port baud rate to device.
8  * This is intended as a usable and extensible API.
9  */
10  /************************************************************************
11  *
12  * OCEAN INSIGHT CONFIDENTIAL
13  * __________________
14  *
15  * [2018] - [2021] Ocean Insight Incorporated
16  * All Rights Reserved.
17  *
18  * NOTICE: All information contained herein is, and remains
19  * the property of Ocean Insight Incorporated and its suppliers,
20  * if any. The intellectual and technical concepts contained
21  * herein are proprietary to Ocean Insight Incorporated
22  * and its suppliers and may be covered by U.S. and Foreign Patents,
23  * patents in process, and are protected by trade secret or copyright law.
24  * Dissemination of this information or reproduction of this material
25  * is strictly forbidden unless prior written permission is obtained
26  * from Ocean Insight Incorporated.
27  *
28  **************************************************************************/
29 
30 #ifndef SERIAL_PORT_API_H
31 #define SERIAL_PORT_API_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL SerialPortAPI {
45  public:
46  SerialPortAPI();
47  virtual ~SerialPortAPI();
48  static SerialPortAPI *getInstance();
49 
50  static void shutdown();
51 
63  int getBaudRate(long deviceID, int *errorCode);
64 
76  void setBaudRate(long deviceID, int *errorCode, int baudRate);
77 
88  void saveSettingsToFlash(long deviceID, int *errorCode);
89 
90  private:
91  static SerialPortAPI *instance;
92  };
93  }
94 }
95 #endif /* SERIAL_PORT_API_H */
Definition: SerialPortAPI.h:44
void saveSettingsToFlash(long deviceID, int *errorCode)
int getBaudRate(long deviceID, int *errorCode)
void setBaudRate(long deviceID, int *errorCode, int baudRate)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: OceanDirectAPI.h:144