OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
UserStringAPI.h
Go to the documentation of this file.
1/*****************************************************
2 * @file UserStringAPI.h
3 * @date January 2022
4 * @author Ocean Insight, Inc.
5 *
6 * This is an interface to OceanDirect that allows
7 * the user to read and write user strin 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 USER_STRING_API_H
31#define USER_STRING_API_H
32
33#include "api/DllDecl.h"
34
41namespace oceandirect {
42 namespace api {
43
44 class DLL_DECL UserStringAPI {
45 public:
47 virtual ~UserStringAPI();
49
50 static void shutdown();
51
67 virtual int getUserString(long deviceID, int *errorCode, char *buffer, int bufferLength);
68
82 virtual void setUserString(long deviceID, int *errorCode, char *buffer, int bufferLength);
83
97 virtual int getUserStringCount(long deviceID, int *errorCode);
98
115 virtual int getUserString(long deviceID, int *errorCode, int index, char *buffer, int bufferLength);
116
132 virtual void setUserString(long deviceID, int *errorCode, int index, char *buffer, int bufferLength);
133
134 protected:
136 };
137 }
138}
139#endif /* USER_STRING_API_H */
Definition UserStringAPI.h:44
virtual void setUserString(long deviceID, int *errorCode, int index, char *buffer, int bufferLength)
static UserStringAPI * getInstance()
virtual int getUserString(long deviceID, int *errorCode, char *buffer, int bufferLength)
virtual int getUserString(long deviceID, int *errorCode, int index, char *buffer, int bufferLength)
static UserStringAPI * instance
Definition UserStringAPI.h:135
virtual int getUserStringCount(long deviceID, int *errorCode)
virtual void setUserString(long deviceID, int *errorCode, char *buffer, int bufferLength)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition OceanDirectAPI.h:147