AxsunOCTCapture 3.8.2
Captures and buffers streamed imaged data from the Axsun Ethernet/PCIe DAQ and displays or retrieves images to a client application on request.
AxsunCommonEnums.h
Go to the documentation of this file.
1
6#ifndef AXSUNCOMMONENUMS_H
7#define AXSUNCOMMONENUMS_H
8
10#ifdef _WIN32
11#ifdef AXSUN_BUILDLIBRARY
12#define AXSUN_EXPORTS __declspec(dllexport)
13#else // else consume library
14#define AXSUN_EXPORTS __declspec(dllimport)
15#endif // AXSUN_BUILDLIBRARY
16#else // linux or macOS
17#define AXSUN_EXPORTS __attribute__((visibility("default")))
18#include <stddef.h> // for size_t on linux
19#define __cdecl // re-define "__cdecl" to be "" for non-Windows targets
20#endif // _WIN32
23#ifdef __cplusplus
24#include <cstdint> // for integer typedefs
25#else
26#include <stdint.h> // for integer typedefs
27#endif // __cplusplus
28
30typedef struct axtimeval_t {
31 int32_t tv_sec;
32 int32_t tv_usec;
34
36typedef enum
37#ifdef __cplusplus
38class
39#endif // __cplusplus
40AxErr {
41 NO_AxERROR = 0,
42 UNKNOWN_ERROR = -10004,
43 INVALID_ARGUMENTS = -10007,
44 CAPABILITY_NOT_SUPPORTED = -10009,
45 UNDEFINED_BOARD_TYPE = -10013,
46
47 CAPTURE_SESSION_NOT_SETUP = -5000,
48 CAPTURE_SESSION_ALREADY_DESTROYED = -5001,
49 CAPTURE_INTERFACE_SETUP_FAILURE = -5002,
50 CAPTURE_SESSION_HANDLE_INVALID = -5003,
51 CALLBACK_NOT_REGISTERED = -5004,
52
53 // return codes for Main Image Buffer management
54 BUFFER_UNINITIALIZED = -5020,
55 BUFFER_ALLOCATION_FAILURE = -5021,
56 BUFFER_IS_EMPTY = -5022,
57 BUFFER_BYTE_ALLIGNMENT_ERROR = -5023,
58 DATA_RATE_MEASUREMENT_FAILURE = -5024,
59 BUFFER_TOO_SMALL = -5025,
60 BUFFER_BUSY = -5026,
61
62 // return codes for file management
63 FILE_INCORRECT_TYPE = -5040,
64 FILE_IDENTIFIER_NOT_READ = -5041,
65 FILE_OPEN_FAILURE = -5042,
66 FILE_CREATION_FAILURE = -5043,
67 FILE_WRITING_FAILURE = -5044,
68 FILE_PATHNAME_TOO_LONG = -5045,
69 NOT_ALLOWED_WHILE_IMAGING = -5046,
70 DATA_TYPE_NOT_SUPPORTED = -5047,
71 FILE_READING_FAILURE = -5048,
72
73 // return codes for JPEG compression/decompression and BMP export
74 JPEG_LOAD_LIBRARY_FAILED = -5050,
75 JPEG_LOAD_FUNCTION_FAILED = -5051,
76 JPEG_INIT_FAILED = -5052,
77 JPEG_DECOMPRESSION_ERROR = -5053,
78 JPEG_COMPRESSION_ERROR = -5054,
79 BMP_WRITING_FAILURE = -5055,
80 OPENCV_LOAD_LIBRARY_FAILED = -5056,
81 IMAGE_EXPORT_RESOURCES_MISSING = -5057,
82
83 // return codes for analog waveform generation control (axScanCmd() and related functions)
84 DAQMX_LOAD_LIBRARY_FAILED = -9000,
85 DAQMX_LOAD_FUNCTION_FAILED = -9001,
86 DAQMX_GET_INFO_FAILED = -9002,
87 DAQMX_RESET_FAILED = -9003,
88 DAQMX_TASK_CREATION_FAILED = -9004,
89 DAQMX_CONFIGURATION_FAILED = -9005,
90 DAQMX_INVALID_SCAN_PARAMS = -9006,
91 DAQMX_MAX_VOLTAGE_EXCEEDED = -9007,
92 //RFU1 = -9008,
93 DAQMX_COMMAND_DEPRECATED = -9009,
94 DAQMX_BURST_RASTER_NOT_SETUP = -9010,
95 DAQMX_COMMAND_NOT_RECOGNIZED = -9011,
96 DAQMX_WAIT_TIMEOUT = -9012,
97 DAQMX_MUTEX_TIMEOUT = -9013,
98 DAQMX_UNSUPPORTED_DEVICE = -9014,
99 DAQMX_DEVICE_NOT_FOUND = -9015,
100 DAQMX_ALREADY_DESTROYED = -9016,
101
102 // return codes for OpenGL display (axSetupDisplay() and related functions)
103 RENDER_MODULE_HANDLE_UNAVAILABLE = -8000,
104 RENDER_WINDOW_CLASS_REGISTRATION_FAILED = -8001,
105 RENDER_WINDOW_CREATION_FAILED = -8002,
106 RENDER_DEVICE_CONTEXT_CREATION_FAILED = -8003,
107 RENDER_PIXEL_SETUP_FAILED = -8004,
108 RENDER_CONTEXT_CREATION_FAILED = -8005,
109 RENDER_GLEW_INIT_FAILED = -8006,
110 RENDER_CONTEXT_CURRENT_FAILURE = -8007,
111 RENDER_OPENGL_VERSION_UNSUPPORTED = -8008,
112 RENDER_SHADER_PROGRAM_FAILED = -8009,
113 RENDER_WAITING_FOR_THREAD = -8010,
114 RENDER_THREAD_NOT_RESPONDING = -8011,
115 RENDER_OPENGL_FUNCTION_ERROR = -8012,
116 RENDER_FUNCTIONS_NOT_SETUP = -8013,
117 RENDER_WINDOW_MOVE_FAILED = -8014,
118 RENDER_WINDOW_STYLE_FAILED = -8015,
119 RENDER_WINDOW_NOT_SETUP = -8016,
120
121 // return codes for Ethernet packet capture
122 PCAP_LOAD_LIBRARY_FAILED = -7000,
123 PCAP_LOAD_FUNCTION_FAILED = -7001,
124 PCAP_NO_DEVICES_FOUND = -7002,
125 PCAP_INTERNAL_ERROR = -7003,
126 PCAP_DEVICE_OPEN_FAILURE = -7004,
127 PCAP_DEVICE_SETUP_FAILURE = -7005,
128
129 // return codes for PCIe packet capture
130 PCIE_LOAD_LIBRARY_FAILED = -7020,
131 PCIE_LOAD_FUNCTION_FAILED = -7021,
132 PCIE_INTERFACE_NOT_SETUP = -7022,
133 PCIE_DEVICE_SETUP_FAILURE = -7023,
134 PCIE_DRIVER_SETUP_FAILURE = -7024,
135 PCIE_DAQ_NOT_INSTALLED = -7025,
136 PCIE_DAQ_INFO_UNAVAILABLE = -7026,
137 PCIE_DEVICE_OPEN_FAILURE = -7027,
138 PCIE_BUFFER_LOCK_FAILURE = -7028,
139 PCIE_WRITE_REGISTER_FAILURE = -7029,
140 PCIE_READ_REGISTER_FAILURE = -7030,
141 PCIE_SYNC_IO_FAILURE = -7031,
142 PCIE_INTERRUPT_ENABLE_FAILURE = -7032,
143 AQDAQ_LOAD_LIBRARY_FAILED = -7033,
144 AQDAQ_LOAD_FUNCTION_FAILED = -7034,
145 AQDAQ_FUNCTION_ERROR = -7035,
146 AQDAQ_NO_IMAGE_AVAILABLE = -7036,
147 PCIE_FLASH_RESET_FAILED = -7037,
148 PCIE_FLASH_READ_FAILED = -7038,
149 PCIE_FLASH_WRITE_FAILED = -7039,
150 PCIE_FLASH_VERIFY_FAILED = -7040,
151 PCIE_FLASH_STATUS_INVALID = -7041,
152 PCIE_FLASH_ERASE_FAILED = -7042,
153
154 // return codes for image/frame/packet request functions
155 DATA_INDEX_INVALID = -9991,
156 DATA_NOT_COMPRESSED = -9992,
157 DATA_TYPE_OR_LENGTH_CHANGED = -9993,
158 DATA_ALLOCATION_TOO_SMALL = -9994,
159 DATA_INCOMPLETE_OR_MISSING = -9996,
160 DATA_RETURNED_IN_PREVIOUS_REQUEST = -9997,
161 DATA_NOT_FOUND_IN_BUFFER = -9999,
162
163 UNINITIALIZED = -10001,
164 CANCELLED_BY_USER = -10002,
165 COMMAND_NOT_IMPLEMENTED = -10003,
166 ALREADY_INITIALIZED = -10005,
167 INSUFFICIENT_ALLOCATION = -10006,
168 DATA_VALIDATION_FAILED = -10008,
169 COMMUNICATION_ERROR = -10010,
170
171 INVALID_SETTINGS = -8,
172 LASER_SWEEPING_ALREADY_STOPPED = -40,
173 COMMAND_NOT_RECOGNIZED = -55,
174 USB_CHECKSUM_ERROR = -104,
175 PAYLOAD_CHECKSUM_ERROR = -108,
176 MOTOR_OUT_OF_RANGE = -121,
177 CANNOT_START_TEC_IN_ERROR = -126,
178 INVALID_CONFIG_PARAMS = -138,
179 CONFIG_NOT_SETUP = -140,
180 ENGINE_TEMP_OUT_OF_RANGE = -150,
181 CANNOT_START_IN_ERROR_STATE = -152,
182
183 USB_READ_ERROR = -1000,
184 USB_WRITE_ERROR = -1001,
185 NO_DEVICE_PRESENT = -1002,
186
187 TCP_READ_ERROR = -1020,
188 TCP_WRITE_ERROR = -1021,
189 TCP_CONNECT_ERROR = -1022,
190
191 SERIAL_READ_ERROR = -1025,
192 SERIAL_WRITE_ERROR = -10250,
193
194 DATA_SIZE_TOO_BIG = -1029,
195 HOSTSIDE_USB_ERROR = -1033,
196 USB_COMMUNICATION_ERROR = -1038,
197 MUTEX_TIMEOUT = -1039,
198 DAC_TABLE_NOT_LOADED = -1048,
199 USB_LOAD_LIBRARY_FAILED = -10011,
200 USB_LOAD_FUNCTION_FAILED = -10012
201
203
204
206typedef enum
207#ifdef __cplusplus
208class
209#endif // __cplusplus
214 IFFT = 3,
216 SQRT = 5,
217 LOG = 6,
222
224typedef enum
225#ifdef __cplusplus
226class
227#endif // __cplusplus
229 CHAN_1 = 0,
230 CHAN_2 = 1,
233 CHANNELMODE_RFU = 4
235
237typedef enum
238#ifdef __cplusplus
239class
240#endif // __cplusplus
265
267typedef enum
268#ifdef __cplusplus
269class
270#endif // __cplusplus
274 LVDS = 2,
275 LVCMOS = 3,
279 LVCMOS2_REAR = 7
281
283typedef enum
284#ifdef __cplusplus
285class
286#endif // __cplusplus
296
298typedef enum
299#ifdef __cplusplus
300class
301#endif // __cplusplus
308
310typedef enum
311#ifdef __cplusplus
312class
313#endif // __cplusplus
316 HANN = 1,
320 TUKEY = 5,
321 ONES = 6,
322 ZEROS = 7
324
326typedef struct window_func_t {
329 uint32_t window_width;
330 uint32_t padded_width;
331 uint32_t right_shift;
332 float a1;
333 float a2;
334 float a3;
336
337
338#endif //AXSUNCOMMONENUMS_H include guard
AxWindowFuncType
Window function types ("type_modifier" refers to member of associated window_func_t struct).
Definition: AxsunCommonEnums.h:314
@ WINFUNCTYPE_RFU
Definition: AxsunCommonEnums.h:315
@ ONES
Definition: AxsunCommonEnums.h:321
@ ZEROS
Definition: AxsunCommonEnums.h:322
@ HANN
Definition: AxsunCommonEnums.h:316
@ TUKEY
Definition: AxsunCommonEnums.h:320
@ HAMMING
Definition: AxsunCommonEnums.h:317
@ BLACKMAN_HARRIS
Definition: AxsunCommonEnums.h:318
@ GAUSSIAN
Definition: AxsunCommonEnums.h:319
struct axtimeval_t axtimeval_t
Structure for packet time stamp with platform-independent size.
AxEdgeSource
DAQ sample clock and trigger sources (incl. Sweep, Image_sync, and Burst Record triggers....
Definition: AxsunCommonEnums.h:271
@ LVDS
Definition: AxsunCommonEnums.h:274
@ INTERNAL_SYNC
Definition: AxsunCommonEnums.h:276
@ EXTERNAL
Definition: AxsunCommonEnums.h:272
@ LVCMOS2_REAR
Definition: AxsunCommonEnums.h:279
@ LVCMOS
Definition: AxsunCommonEnums.h:275
@ LVCMOS_FRONT
Definition: AxsunCommonEnums.h:278
@ INTERNAL
Definition: AxsunCommonEnums.h:273
@ LVDS_FRONT
Definition: AxsunCommonEnums.h:277
AxRcrdTrigBehavior
DAQ Burst Record trigger behavior. Applies to "External" trigger sources as described in AxEdgeSource...
Definition: AxsunCommonEnums.h:287
@ STARTRISING_STOPRISING
Definition: AxsunCommonEnums.h:290
@ STARTRISING_STOPFALLING
Definition: AxsunCommonEnums.h:292
@ STARTFALLING_STOPFALLING
Definition: AxsunCommonEnums.h:291
@ STARTRISING_STOPCOUNT
Definition: AxsunCommonEnums.h:288
@ STARTFALLING_STOPCOUNT
Definition: AxsunCommonEnums.h:289
@ STARTFALLING_STOPRISING
Definition: AxsunCommonEnums.h:293
@ REC_TRIG_BEHAVIOR_RFU
Definition: AxsunCommonEnums.h:294
AxChannelMode
DAQ channel selection modes.
Definition: AxsunCommonEnums.h:228
@ CHAN_2
Definition: AxsunCommonEnums.h:230
@ INTERLEAVE_CHANNELS
Definition: AxsunCommonEnums.h:232
@ CHANNELMODE_RFU
Definition: AxsunCommonEnums.h:233
@ SUM_CHANNELS
Definition: AxsunCommonEnums.h:231
@ CHAN_1
Definition: AxsunCommonEnums.h:229
AxSwpTrgMode
DAQ sweep trigger edge modes.
Definition: AxsunCommonEnums.h:302
@ SWPTRIG_RISING
Definition: AxsunCommonEnums.h:303
@ SWPTRIG_RFU
Definition: AxsunCommonEnums.h:306
@ SWPTRIG_FALLING
Definition: AxsunCommonEnums.h:304
@ SWPTRIG_DUALEDGE
Definition: AxsunCommonEnums.h:305
AxDataType
Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode...
Definition: AxsunCommonEnums.h:241
@ U8
Definition: AxsunCommonEnums.h:243
@ U32
Definition: AxsunCommonEnums.h:247
@ U32_le
Definition: AxsunCommonEnums.h:255
@ CMPLX
Definition: AxsunCommonEnums.h:249
@ AXDATATYPE_RFU
Definition: AxsunCommonEnums.h:263
@ I16
Definition: AxsunCommonEnums.h:251
@ I16_le
Definition: AxsunCommonEnums.h:259
@ U16_le
Definition: AxsunCommonEnums.h:253
@ CMPLX_le
Definition: AxsunCommonEnums.h:257
@ I32_le
Definition: AxsunCommonEnums.h:261
@ U16
Definition: AxsunCommonEnums.h:245
AxPipelineMode
DAQ pipeline modes.
Definition: AxsunCommonEnums.h:210
@ SQRT
Definition: AxsunCommonEnums.h:216
@ JPEG_COMP
Definition: AxsunCommonEnums.h:219
@ IFFT
Definition: AxsunCommonEnums.h:214
@ WINDOWED
Definition: AxsunCommonEnums.h:213
@ UNKNOWN
Definition: AxsunCommonEnums.h:211
@ MOD_SQUARED
Definition: AxsunCommonEnums.h:215
@ RAW_ADC
Definition: AxsunCommonEnums.h:212
@ LOG
Definition: AxsunCommonEnums.h:217
@ EIGHT_BIT
Definition: AxsunCommonEnums.h:218
@ PIPELINEMODE_RFU
Definition: AxsunCommonEnums.h:220
AxErr
Error codes returned from AxsunOCTCapture or AxsunOCTControl_LW functions. Use axGetErrorString() in ...
Definition: AxsunCommonEnums.h:40
struct window_func_t window_func_t
Parameters for calculating a complex-valued window function with phase described using a Taylor serie...
Structure for packet time stamp with platform-independent size.
Definition: AxsunCommonEnums.h:30
int32_t tv_sec
Definition: AxsunCommonEnums.h:31
int32_t tv_usec
Definition: AxsunCommonEnums.h:32
Parameters for calculating a complex-valued window function with phase described using a Taylor serie...
Definition: AxsunCommonEnums.h:326
float a2
Definition: AxsunCommonEnums.h:333
float a3
Definition: AxsunCommonEnums.h:334
uint32_t window_width
Definition: AxsunCommonEnums.h:329
AxWindowFuncType type
Definition: AxsunCommonEnums.h:327
uint32_t right_shift
Definition: AxsunCommonEnums.h:331
uint32_t padded_width
Definition: AxsunCommonEnums.h:330
float type_modifier
Definition: AxsunCommonEnums.h:328
float a1
Definition: AxsunCommonEnums.h:332