DSRemoteConnect C++ Library 1.1.3.24 Remote connection library for Dewesoft measurement applications

Loading...
Searching...
No Matches
ConstsAndTypeDefs_Documented.h
Go to the documentation of this file.
1
8#pragma once
9
17 typedef enum {
19 DSX_TOO_MANY_SAMPLES_AVAILABLE = 2,
20
22 DSX_END_OF_ENUM = 1,
23
25 DSX_NO_ERROR = 0,
26
28 DSX_DCOM_CHANNEL_ID_NOT_FOUND = -1,
29
31 DSX_DCOM_UNKNOWN_ERROR = -2,
32
34 DSX_DCOM_NO_DATA = -3,
35
37 DSX_DCOM_NOT_CONNECTED = -4,
38
40 DSX_COUNT_OUT_OF_BOUNDS = -5,
41
43 DSX_NET_UNABLE_TO_CONNECT = -6,
44
46 DSX_NET_UNKNOWN_ERROR = -7,
47
49 DSX_UNKNOWN_ERROR = -8,
50
52 DSX_NULL_HANDLER = -9,
53
55 DSX_INVALID_CONNECTION_STRING = -10,
56
58 DSX_DCOM_ISSUE = -11,
59
61 DSX_DCOM_COULD_NOT_CONNECT = -12,
62
64 DSX_DCOM_NO_CHANNELS_TO_ENUMERATE = -13,
65
67 DSX_DCOM_EMPTY_ARRAY = -14,
68
70 DSX_CANNOT_MAKE_CH_INSTANCE = -15,
71
73 DSX_WRONG_PROPS_NAME = -16,
74
76 DSX_ERROR_GETTING_LENGTH_PROPS = -17,
77
79 DSX_NET_COMMAND_NOT_SUPPORTED = -18,
80
82 DSX_CH_IS_NOT_CONTROL = -19,
83
85 DSX_NET_SETUP_NOT_FOUND = -20,
86
88 DSX_NET_BUFFER_OVERWRITTEN = -21,
89
91 DSX_NET_ISACQ_CHECKFAILED = -22,
92
94 DSX_NET_STOPPING_ACQ_FAILED = -23,
95
97 DSX_NET_INITIALIZING_VECTOR_CH = -24,
98
100 DSX_NET_GETTIMING_FAILED = -25,
101
103 DSX_NET_PREPARECHFORTRANSFER_FAILED = -26,
104
106 DSX_NET_STARTTRANSFER_FAILED = -27,
107
109 DSX_NET_STARTACQ_FAILED = -28
110} DX_ERROR_CODE;
111
118 typedef enum {
120 DSX_CONNECTION_TYPE_DCOM = 0,
121
123 DSX_CONNECTION_TYPE_NET = 1
124} DSX_CONNECTION_TYPE;
125
132 typedef enum {
134 DSX_CH_ASYNC = 0,
135
137 DSX_CH_SYNC = 1,
138
140 DSX_CH_SINGLE_VALUE = 2
141} DSX_CH_TYPE;
142
149 typedef enum {
150 dtByte = 0,
151 dtShortInt = 1,
152 dtSmallInt = 2,
153 dtWord = 3,
154 dtInteger = 4,
155 dtSingle = 5,
156 dtInt64 = 6,
157 dtDouble = 7,
158 dtLongword = 8,
159 dtComplexSingle = 9,
160 dtComplexDouble = 10,
161 dtText = 11,
162 dtBinary = 12,
163 dtCANMessage = 13,
164 dtCANFDMessage = 14,
165 dtBytes8 = 15,
166 dtBytes16 = 16,
167 dtBytes32 = 17,
168 dtBytes64 = 18
169} DSX_DATA_TYPE;
170
178 typedef enum {
179 dtSignedCharNet = 0,
180 dtUnSignedCharNet = 1,
181 dtShortNet = 2,
182 dtUnsignedShortNet = 3,
183 dtIntegerNet = 4,
184 dtFloatNet = 5,
185 dtDoubleNet = 7,
186 dtLongLongNet = 6,
187 dtLongWordNet = 8,
188 dtComplexSingleNet = 9,
189 dtComplexDoubleNet = 10,
190 dtTextNet = 11,
191 dtBinaryNet = 12,
192 dtCANMessageNet = 13,
193 dtCANFDMessageNet = 14,
194 dtBytes8Net = 15,
195 dtBytes16Net = 16,
196 dtBytes32Net = 17,
197 dtBytes64Net = 18
198} DSX_NET_DATA_TYPE;
199
200// ============================================================================
201// @defgroup net_protocol Network Protocol Constants
202// @brief Constants used in network communication protocol
203// @{
204// ============================================================================
205
207#define CHANNEL_LIST_MAX_RESPONSE_LENGTH 8192
208
210#define NET_CONNECTED_MSG "+CONNECTED"
211#define NET_CONNECTED_MSG_LEN (strlen(NET_CONNECTED_MSG) - 1)
212
214#define NET_ERR_MSG "+ERR"
215#define NET_ERR_MSG_LEN (strlen(NET_ERR_MSG) - 1)
216
218#define NET_STX_MSG "+STX"
219#define NET_STX_MSG_LEN (strlen(NET_STX_MSG) - 1)
220
222#define NET_ETX_MSG "+ETX"
223#define NET_ETX_MSG_LEN (strlen(NET_ETX_MSG) - 1)
224
226#define NET_OK_MSG "+ OK"
227#define NET_OK_MSG_LEN (strlen(NET_OK_MSG) - 1)
228
230#define NET_CMD_LIST_USED_CHANNELS "LISTUSEDCHS"
231
232 // end of net_protocol group
233
234// ============================================================================
235// @defgroup buffer_constants Buffer and Size Constants
236// @brief Constants defining buffer sizes and limits
237// @{
238// ============================================================================
239
241#define DEFAULT_BUFLEN 512
242
244#define NAME_LENGTH 100
245
247#define PACKET_BUF_LEN 10000
248
250#define SAMPLES_BUF_LEN 10000
251
253#define MAX_CHANNEL_INDEX_LENGTH 10
254
255 // end of buffer_constants group
256
336
DSX_NET_DATA_TYPE
DSX_NET_DATA_TYPE
Data types for NET-based channels.
Definition ConstsAndTypeDefs_Documented.h:178
dtBytes16Net
@ dtBytes16Net
16-byte data block
Definition ConstsAndTypeDefs_Documented.h:195
dtFloatNet
@ dtFloatNet
32-bit floating point
Definition ConstsAndTypeDefs_Documented.h:184
dtSignedCharNet
@ dtSignedCharNet
8-bit signed character
Definition ConstsAndTypeDefs_Documented.h:179
dtCANMessageNet
@ dtCANMessageNet
CAN bus message.
Definition ConstsAndTypeDefs_Documented.h:192
dtUnSignedCharNet
@ dtUnSignedCharNet
8-bit unsigned character
Definition ConstsAndTypeDefs_Documented.h:180
dtBytes64Net
@ dtBytes64Net
64-byte data block
Definition ConstsAndTypeDefs_Documented.h:197
dtLongWordNet
@ dtLongWordNet
32-bit unsigned integer
Definition ConstsAndTypeDefs_Documented.h:187
dtBinaryNet
@ dtBinaryNet
Binary data.
Definition ConstsAndTypeDefs_Documented.h:191
dtTextNet
@ dtTextNet
Text/string data.
Definition ConstsAndTypeDefs_Documented.h:190
dtBytes8Net
@ dtBytes8Net
8-byte data block
Definition ConstsAndTypeDefs_Documented.h:194
dtComplexSingleNet
@ dtComplexSingleNet
Complex 32-bit floating point.
Definition ConstsAndTypeDefs_Documented.h:188
dtBytes32Net
@ dtBytes32Net
32-byte data block
Definition ConstsAndTypeDefs_Documented.h:196
dtLongLongNet
@ dtLongLongNet
64-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:186
dtCANFDMessageNet
@ dtCANFDMessageNet
CAN FD message.
Definition ConstsAndTypeDefs_Documented.h:193
dtDoubleNet
@ dtDoubleNet
64-bit floating point
Definition ConstsAndTypeDefs_Documented.h:185
dtIntegerNet
@ dtIntegerNet
32-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:183
dtComplexDoubleNet
@ dtComplexDoubleNet
Complex 64-bit floating point.
Definition ConstsAndTypeDefs_Documented.h:189
dtShortNet
@ dtShortNet
16-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:181
dtUnsignedShortNet
@ dtUnsignedShortNet
16-bit unsigned integer
Definition ConstsAndTypeDefs_Documented.h:182
DSX_DATA_TYPE
DSX_DATA_TYPE
Data types for DCOM-based channels.
Definition ConstsAndTypeDefs_Documented.h:149
dtComplexDouble
@ dtComplexDouble
Complex 64-bit floating point.
Definition ConstsAndTypeDefs_Documented.h:160
dtInteger
@ dtInteger
32-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:154
dtBytes16
@ dtBytes16
16-byte data block
Definition ConstsAndTypeDefs_Documented.h:166
dtComplexSingle
@ dtComplexSingle
Complex 32-bit floating point.
Definition ConstsAndTypeDefs_Documented.h:159
dtBinary
@ dtBinary
Binary data.
Definition ConstsAndTypeDefs_Documented.h:162
dtBytes8
@ dtBytes8
8-byte data block
Definition ConstsAndTypeDefs_Documented.h:165
dtBytes32
@ dtBytes32
32-byte data block
Definition ConstsAndTypeDefs_Documented.h:167
dtShortInt
@ dtShortInt
16-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:151
dtLongword
@ dtLongword
32-bit unsigned integer
Definition ConstsAndTypeDefs_Documented.h:158
dtCANFDMessage
@ dtCANFDMessage
CAN FD message.
Definition ConstsAndTypeDefs_Documented.h:164
dtCANMessage
@ dtCANMessage
CAN bus message.
Definition ConstsAndTypeDefs_Documented.h:163
dtSmallInt
@ dtSmallInt
16-bit signed integer (alternative)
Definition ConstsAndTypeDefs_Documented.h:152
dtSingle
@ dtSingle
32-bit floating point
Definition ConstsAndTypeDefs_Documented.h:155
dtInt64
@ dtInt64
64-bit signed integer
Definition ConstsAndTypeDefs_Documented.h:156
dtWord
@ dtWord
16-bit unsigned integer
Definition ConstsAndTypeDefs_Documented.h:153
dtText
@ dtText
Text/string data.
Definition ConstsAndTypeDefs_Documented.h:161
dtBytes64
@ dtBytes64
64-byte data block
Definition ConstsAndTypeDefs_Documented.h:168
dtByte
@ dtByte
8-bit unsigned byte
Definition ConstsAndTypeDefs_Documented.h:150
dtDouble
@ dtDouble
64-bit floating point
Definition ConstsAndTypeDefs_Documented.h:157
DX_ERROR_CODE
DX_ERROR_CODE
Error codes returned by DSRemoteConnect functions.
Definition ConstsAndTypeDefs_Documented.h:17
DSX_NET_COMMAND_NOT_SUPPORTED
@ DSX_NET_COMMAND_NOT_SUPPORTED
NET: Command not supported by server.
Definition ConstsAndTypeDefs_Documented.h:79
DSX_COUNT_OUT_OF_BOUNDS
@ DSX_COUNT_OUT_OF_BOUNDS
Count parameter out of valid bounds.
Definition ConstsAndTypeDefs_Documented.h:40
DSX_DCOM_COULD_NOT_CONNECT
@ DSX_DCOM_COULD_NOT_CONNECT
DCOM: Could not establish DCOM connection.
Definition ConstsAndTypeDefs_Documented.h:61
DSX_DCOM_UNKNOWN_ERROR
@ DSX_DCOM_UNKNOWN_ERROR
DCOM: Unknown error occurred.
Definition ConstsAndTypeDefs_Documented.h:31
DSX_CANNOT_MAKE_CH_INSTANCE
@ DSX_CANNOT_MAKE_CH_INSTANCE
Cannot create channel instance.
Definition ConstsAndTypeDefs_Documented.h:70
DSX_ERROR_GETTING_LENGTH_PROPS
@ DSX_ERROR_GETTING_LENGTH_PROPS
Error getting property length.
Definition ConstsAndTypeDefs_Documented.h:76
DSX_NULL_HANDLER
@ DSX_NULL_HANDLER
Null handle or pointer passed to function.
Definition ConstsAndTypeDefs_Documented.h:52
DSX_DCOM_NO_DATA
@ DSX_DCOM_NO_DATA
DCOM: No data available for reading.
Definition ConstsAndTypeDefs_Documented.h:34
DSX_NET_STARTACQ_FAILED
@ DSX_NET_STARTACQ_FAILED
NET: Failed to start acquisition.
Definition ConstsAndTypeDefs_Documented.h:109
DSX_DCOM_NOT_CONNECTED
@ DSX_DCOM_NOT_CONNECTED
DCOM: Not connected to Dewesoft application.
Definition ConstsAndTypeDefs_Documented.h:37
DSX_INVALID_CONNECTION_STRING
@ DSX_INVALID_CONNECTION_STRING
Invalid connection string format.
Definition ConstsAndTypeDefs_Documented.h:55
DSX_TOO_MANY_SAMPLES_AVAILABLE
@ DSX_TOO_MANY_SAMPLES_AVAILABLE
More samples available than requested (warning)
Definition ConstsAndTypeDefs_Documented.h:19
DSX_NET_STOPPING_ACQ_FAILED
@ DSX_NET_STOPPING_ACQ_FAILED
NET: Failed to stop acquisition.
Definition ConstsAndTypeDefs_Documented.h:94
DSX_NET_INITIALIZING_VECTOR_CH
@ DSX_NET_INITIALIZING_VECTOR_CH
NET: Error initializing vector channels.
Definition ConstsAndTypeDefs_Documented.h:97
DSX_DCOM_EMPTY_ARRAY
@ DSX_DCOM_EMPTY_ARRAY
DCOM: Empty array returned.
Definition ConstsAndTypeDefs_Documented.h:67
DSX_UNKNOWN_ERROR
@ DSX_UNKNOWN_ERROR
General unknown error.
Definition ConstsAndTypeDefs_Documented.h:49
DSX_NET_UNABLE_TO_CONNECT
@ DSX_NET_UNABLE_TO_CONNECT
NET: Unable to establish network connection.
Definition ConstsAndTypeDefs_Documented.h:43
DSX_DCOM_ISSUE
@ DSX_DCOM_ISSUE
DCOM: General DCOM interface issue.
Definition ConstsAndTypeDefs_Documented.h:58
DSX_NET_SETUP_NOT_FOUND
@ DSX_NET_SETUP_NOT_FOUND
NET: Setup file not found.
Definition ConstsAndTypeDefs_Documented.h:85
DSX_NET_PREPARECHFORTRANSFER_FAILED
@ DSX_NET_PREPARECHFORTRANSFER_FAILED
NET: Failed to prepare channel for transfer.
Definition ConstsAndTypeDefs_Documented.h:103
DSX_DCOM_CHANNEL_ID_NOT_FOUND
@ DSX_DCOM_CHANNEL_ID_NOT_FOUND
DCOM: Channel ID not found in current setup.
Definition ConstsAndTypeDefs_Documented.h:28
DSX_NET_GETTIMING_FAILED
@ DSX_NET_GETTIMING_FAILED
NET: Failed to get timing information.
Definition ConstsAndTypeDefs_Documented.h:100
DSX_NET_UNKNOWN_ERROR
@ DSX_NET_UNKNOWN_ERROR
NET: Unknown network error occurred.
Definition ConstsAndTypeDefs_Documented.h:46
DSX_WRONG_PROPS_NAME
@ DSX_WRONG_PROPS_NAME
Wrong property name specified.
Definition ConstsAndTypeDefs_Documented.h:73
DSX_NET_ISACQ_CHECKFAILED
@ DSX_NET_ISACQ_CHECKFAILED
NET: Acquisition status check failed.
Definition ConstsAndTypeDefs_Documented.h:91
DSX_NET_BUFFER_OVERWRITTEN
@ DSX_NET_BUFFER_OVERWRITTEN
NET: Buffer was overwritten before reading.
Definition ConstsAndTypeDefs_Documented.h:88
DSX_NO_ERROR
@ DSX_NO_ERROR
No error - operation successful.
Definition ConstsAndTypeDefs_Documented.h:25
DSX_DCOM_NO_CHANNELS_TO_ENUMERATE
@ DSX_DCOM_NO_CHANNELS_TO_ENUMERATE
DCOM: No channels available for enumeration.
Definition ConstsAndTypeDefs_Documented.h:64
DSX_NET_STARTTRANSFER_FAILED
@ DSX_NET_STARTTRANSFER_FAILED
NET: Failed to start data transfer.
Definition ConstsAndTypeDefs_Documented.h:106
DSX_CH_IS_NOT_CONTROL
@ DSX_CH_IS_NOT_CONTROL
Channel is not a control channel.
Definition ConstsAndTypeDefs_Documented.h:82
DSX_END_OF_ENUM
@ DSX_END_OF_ENUM
End of enumeration reached.
Definition ConstsAndTypeDefs_Documented.h:22
DSX_CH_TYPE
DSX_CH_TYPE
Channel data types based on sampling characteristics.
Definition ConstsAndTypeDefs_Documented.h:132
DSX_CH_ASYNC
@ DSX_CH_ASYNC
Asynchronous channel - data arrives at irregular intervals.
Definition ConstsAndTypeDefs_Documented.h:134
DSX_CH_SINGLE_VALUE
@ DSX_CH_SINGLE_VALUE
Single value channel - provides one value per measurement.
Definition ConstsAndTypeDefs_Documented.h:140
DSX_CH_SYNC
@ DSX_CH_SYNC
Synchronous channel - data sampled at regular intervals.
Definition ConstsAndTypeDefs_Documented.h:137
DSX_CONNECTION_TYPE
DSX_CONNECTION_TYPE
Connection types supported by DSRemoteConnect.
Definition ConstsAndTypeDefs_Documented.h:118
DSX_CONNECTION_TYPE_DCOM
@ DSX_CONNECTION_TYPE_DCOM
DCOM connection for local/remote Windows applications.
Definition ConstsAndTypeDefs_Documented.h:120
DSX_CONNECTION_TYPE_NET
@ DSX_CONNECTION_TYPE_NET
Network connection using TCP/IP protocols.
Definition ConstsAndTypeDefs_Documented.h:123