AxsunOCTControl_LW v2.2.0
A cross-platform library for controlling Axsun SS-OCT laser engine and data acquisition devices.
Loading...
Searching...
No Matches
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 OPENCV_LOAD_FUNCTION_FAILED = -5058,
83 OPENCV_SETUP_FAILED = -5059,
84
85 // return codes for analog waveform generation control (axScanCmd() and related functions)
86 DAQMX_LOAD_LIBRARY_FAILED = -9000,
87 DAQMX_LOAD_FUNCTION_FAILED = -9001,
88 DAQMX_GET_INFO_FAILED = -9002,
89 DAQMX_RESET_FAILED = -9003,
90 DAQMX_TASK_CREATION_FAILED = -9004,
91 DAQMX_CONFIGURATION_FAILED = -9005,
92 DAQMX_INVALID_SCAN_PARAMS = -9006,
93 DAQMX_MAX_VOLTAGE_EXCEEDED = -9007,
94 //RFU1 = -9008,
95 DAQMX_COMMAND_DEPRECATED = -9009,
96 DAQMX_BURST_RASTER_NOT_SETUP = -9010,
97 DAQMX_COMMAND_NOT_RECOGNIZED = -9011,
98 DAQMX_WAIT_TIMEOUT = -9012,
99 DAQMX_MUTEX_TIMEOUT = -9013,
100 DAQMX_UNSUPPORTED_DEVICE = -9014,
101 DAQMX_DEVICE_NOT_FOUND = -9015,
102 DAQMX_ALREADY_DESTROYED = -9016,
103
104 // return codes for OpenGL display (axSetupDisplay() and related functions)
105 RENDER_MODULE_HANDLE_UNAVAILABLE = -8000,
106 RENDER_WINDOW_CLASS_REGISTRATION_FAILED = -8001,
107 RENDER_WINDOW_CREATION_FAILED = -8002,
108 RENDER_DEVICE_CONTEXT_CREATION_FAILED = -8003,
109 RENDER_PIXEL_SETUP_FAILED = -8004,
110 RENDER_CONTEXT_CREATION_FAILED = -8005,
111 RENDER_GLEW_INIT_FAILED = -8006,
112 RENDER_CONTEXT_CURRENT_FAILURE = -8007,
113 RENDER_OPENGL_VERSION_UNSUPPORTED = -8008,
114 RENDER_SHADER_PROGRAM_FAILED = -8009,
115 RENDER_WAITING_FOR_THREAD = -8010,
116 RENDER_THREAD_NOT_RESPONDING = -8011,
117 RENDER_OPENGL_FUNCTION_ERROR = -8012,
118 RENDER_FUNCTIONS_NOT_SETUP = -8013,
119 RENDER_WINDOW_MOVE_FAILED = -8014,
120 RENDER_WINDOW_STYLE_FAILED = -8015,
121 RENDER_WINDOW_NOT_SETUP = -8016,
122
123 // return codes for Ethernet packet capture
124 PCAP_LOAD_LIBRARY_FAILED = -7000,
125 PCAP_LOAD_FUNCTION_FAILED = -7001,
126 PCAP_NO_DEVICES_FOUND = -7002,
127 PCAP_INTERNAL_ERROR = -7003,
128 PCAP_DEVICE_OPEN_FAILURE = -7004,
129 PCAP_DEVICE_SETUP_FAILURE = -7005,
130
131 // return codes for PCIe packet capture
132 PCIE_LOAD_LIBRARY_FAILED = -7020,
133 PCIE_LOAD_FUNCTION_FAILED = -7021,
134 PCIE_INTERFACE_NOT_SETUP = -7022,
135 PCIE_DEVICE_SETUP_FAILURE = -7023,
136 PCIE_DRIVER_SETUP_FAILURE = -7024,
137 PCIE_DAQ_NOT_INSTALLED = -7025,
138 PCIE_DAQ_INFO_UNAVAILABLE = -7026,
139 PCIE_DEVICE_OPEN_FAILURE = -7027,
140 PCIE_BUFFER_LOCK_FAILURE = -7028,
141 PCIE_WRITE_REGISTER_FAILURE = -7029,
142 PCIE_READ_REGISTER_FAILURE = -7030,
143 PCIE_SYNC_IO_FAILURE = -7031,
144 PCIE_INTERRUPT_ENABLE_FAILURE = -7032,
145 AQDAQ_LOAD_LIBRARY_FAILED = -7033,
146 AQDAQ_LOAD_FUNCTION_FAILED = -7034,
147 AQDAQ_FUNCTION_ERROR = -7035,
148 AQDAQ_NO_IMAGE_AVAILABLE = -7036,
149 PCIE_FLASH_RESET_FAILED = -7037,
150 PCIE_FLASH_READ_FAILED = -7038,
151 PCIE_FLASH_WRITE_FAILED = -7039,
152 PCIE_FLASH_VERIFY_FAILED = -7040,
153 PCIE_FLASH_STATUS_INVALID = -7041,
154 PCIE_FLASH_ERASE_FAILED = -7042,
155
156 // return codes for image/frame/packet request functions
157 DATA_INDEX_INVALID = -9991,
158 DATA_NOT_COMPRESSED = -9992,
159 DATA_TYPE_OR_LENGTH_CHANGED = -9993,
160 DATA_ALLOCATION_TOO_SMALL = -9994,
161 DATA_INCOMPLETE_OR_MISSING = -9996,
162 DATA_RETURNED_IN_PREVIOUS_REQUEST = -9997,
163 DATA_NOT_FOUND_IN_BUFFER = -9999,
164
165 UNINITIALIZED = -10001,
166 CANCELLED_BY_USER = -10002,
167 COMMAND_NOT_IMPLEMENTED = -10003,
168 ALREADY_INITIALIZED = -10005,
169 INSUFFICIENT_ALLOCATION = -10006,
170 DATA_VALIDATION_FAILED = -10008,
171 COMMUNICATION_ERROR = -10010,
172
173 INVALID_SETTINGS = -8,
174 LASER_SWEEPING_ALREADY_STOPPED = -40,
175 COMMAND_NOT_RECOGNIZED = -55,
176 USB_CHECKSUM_ERROR = -104,
177 PAYLOAD_CHECKSUM_ERROR = -108,
178 MOTOR_OUT_OF_RANGE = -121,
179 CANNOT_START_TEC_IN_ERROR = -126,
180 INVALID_CONFIG_PARAMS = -138,
181 CONFIG_NOT_SETUP = -140,
182 ENGINE_TEMP_OUT_OF_RANGE = -150,
183 CANNOT_START_IN_ERROR_STATE = -152,
184 NAMED_DATA_IS_LOCKED = -293,
185
186 USB_READ_ERROR = -1000,
187 USB_WRITE_ERROR = -1001,
188 NO_DEVICE_PRESENT = -1002,
189
190 TCP_READ_ERROR = -1020,
191 TCP_WRITE_ERROR = -1021,
192 TCP_CONNECT_ERROR = -1022,
193
194 SERIAL_READ_ERROR = -1025,
195 SERIAL_WRITE_ERROR = -10250,
196
197 DATA_SIZE_TOO_BIG = -1029,
198 HOSTSIDE_USB_ERROR = -1033,
199 USB_COMMUNICATION_ERROR = -1038,
200 MUTEX_TIMEOUT = -1039,
201 DAC_TABLE_NOT_LOADED = -1048,
202 USB_LOAD_LIBRARY_FAILED = -10011,
203 USB_LOAD_FUNCTION_FAILED = -10012,
204
205 STMBL_LOAD_LIBRARY_FAILED = -10014,
206 STMBL_LOAD_FUNCTION_FAILED = -10015,
207 STMBL_DEVICE_NOT_FOUND = -10016,
208 STMBL_DATABASE_NOT_FOUND = -10017,
209 STMBL_LOAD_FAILED = -10018,
210 STMBL_MAX_DEVICES_EXCEEDED = -10019,
211
213
214
216typedef enum
217#ifdef __cplusplus
218class
219#endif // __cplusplus
224 IFFT = 3,
226 SQRT = 5,
227 LOG = 6,
232
234typedef enum
235#ifdef __cplusplus
236class
237#endif // __cplusplus
239 CHAN_1 = 0,
240 CHAN_2 = 1,
243 CHANNELMODE_RFU = 4
245
247typedef enum
248#ifdef __cplusplus
249class
250#endif // __cplusplus
275
277typedef enum
278#ifdef __cplusplus
279class
280#endif // __cplusplus
284 LVDS = 2,
285 LVCMOS = 3,
289 LVCMOS2_REAR = 7
291
306
308typedef enum
309#ifdef __cplusplus
310class
311#endif // __cplusplus
318
320typedef enum
321#ifdef __cplusplus
322class
323#endif // __cplusplus
326 HANN = 1,
330 TUKEY = 5,
331 ONES = 6,
332 ZEROS = 7
334
336typedef enum
337#ifdef __cplusplus
338class
339#endif // __cplusplus
345
357
359typedef struct edaq_diags_t {
360 float fpga_temp;
361 float aux_temp;
362 float adc_temp;
364 float vcc_int;
365 float vcc_aux;
366 float fan_speed;
368 uint16_t error_status;
369 uint64_t rfu;
371
372#endif //AXSUNCOMMONENUMS_H include guard
AxResampSetup
Controls target parameter of the arguments in the corresponding function for setup of FPGA resampling...
Definition AxsunCommonEnums.h:340
@ RESAMP_ENABLE
Definition AxsunCommonEnums.h:341
@ RESAMP_MULTIPLIER
Definition AxsunCommonEnums.h:342
@ RESAMP_CLOCK_DELAY
Definition AxsunCommonEnums.h:343
AxWindowFuncType
Window function types ("type_modifier" refers to member of associated window_func_t struct).
Definition AxsunCommonEnums.h:324
@ WINFUNCTYPE_RFU
Definition AxsunCommonEnums.h:325
@ ONES
Definition AxsunCommonEnums.h:331
@ ZEROS
Definition AxsunCommonEnums.h:332
@ HANN
Definition AxsunCommonEnums.h:326
@ TUKEY
Definition AxsunCommonEnums.h:330
@ HAMMING
Definition AxsunCommonEnums.h:327
@ BLACKMAN_HARRIS
Definition AxsunCommonEnums.h:328
@ GAUSSIAN
Definition AxsunCommonEnums.h:329
struct edaq_diags_t edaq_diags_t
PCIe/Ethernet DAQ diagnostic fields.
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:281
@ LVDS
Definition AxsunCommonEnums.h:284
@ INTERNAL_SYNC
Definition AxsunCommonEnums.h:286
@ EXTERNAL
Definition AxsunCommonEnums.h:282
@ LVCMOS2_REAR
Definition AxsunCommonEnums.h:289
@ LVCMOS
Definition AxsunCommonEnums.h:285
@ LVCMOS_FRONT
Definition AxsunCommonEnums.h:288
@ INTERNAL
Definition AxsunCommonEnums.h:283
@ LVDS_FRONT
Definition AxsunCommonEnums.h:287
AxRcrdTrigBehavior
DAQ Burst Record trigger behavior. Applies to "External" trigger sources as described in AxEdgeSource...
Definition AxsunCommonEnums.h:297
@ STARTRISING_STOPRISING
Definition AxsunCommonEnums.h:300
@ STARTRISING_STOPFALLING
Definition AxsunCommonEnums.h:302
@ STARTFALLING_STOPFALLING
Definition AxsunCommonEnums.h:301
@ STARTRISING_STOPCOUNT
Definition AxsunCommonEnums.h:298
@ STARTFALLING_STOPCOUNT
Definition AxsunCommonEnums.h:299
@ STARTFALLING_STOPRISING
Definition AxsunCommonEnums.h:303
@ REC_TRIG_BEHAVIOR_RFU
Definition AxsunCommonEnums.h:304
AxChannelMode
DAQ channel selection modes.
Definition AxsunCommonEnums.h:238
@ CHAN_2
Definition AxsunCommonEnums.h:240
@ INTERLEAVE_CHANNELS
Definition AxsunCommonEnums.h:242
@ CHANNELMODE_RFU
Definition AxsunCommonEnums.h:243
@ SUM_CHANNELS
Definition AxsunCommonEnums.h:241
@ CHAN_1
Definition AxsunCommonEnums.h:239
AxSwpTrgMode
DAQ sweep trigger edge modes.
Definition AxsunCommonEnums.h:312
@ SWPTRIG_RISING
Definition AxsunCommonEnums.h:313
@ SWPTRIG_RFU
Definition AxsunCommonEnums.h:316
@ SWPTRIG_FALLING
Definition AxsunCommonEnums.h:314
@ SWPTRIG_DUALEDGE
Definition AxsunCommonEnums.h:315
AxDataType
Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode...
Definition AxsunCommonEnums.h:251
@ U8
Definition AxsunCommonEnums.h:253
@ U32
Definition AxsunCommonEnums.h:257
@ U32_le
Definition AxsunCommonEnums.h:265
@ CMPLX
Definition AxsunCommonEnums.h:259
@ AXDATATYPE_RFU
Definition AxsunCommonEnums.h:273
@ I16
Definition AxsunCommonEnums.h:261
@ I16_le
Definition AxsunCommonEnums.h:269
@ U16_le
Definition AxsunCommonEnums.h:263
@ CMPLX_le
Definition AxsunCommonEnums.h:267
@ I32_le
Definition AxsunCommonEnums.h:271
@ U16
Definition AxsunCommonEnums.h:255
AxPipelineMode
DAQ pipeline modes.
Definition AxsunCommonEnums.h:220
@ SQRT
Definition AxsunCommonEnums.h:226
@ JPEG_COMP
Definition AxsunCommonEnums.h:229
@ IFFT
Definition AxsunCommonEnums.h:224
@ WINDOWED
Definition AxsunCommonEnums.h:223
@ UNKNOWN
Definition AxsunCommonEnums.h:221
@ MOD_SQUARED
Definition AxsunCommonEnums.h:225
@ RAW_ADC
Definition AxsunCommonEnums.h:222
@ LOG
Definition AxsunCommonEnums.h:227
@ EIGHT_BIT
Definition AxsunCommonEnums.h:228
@ PIPELINEMODE_RFU
Definition AxsunCommonEnums.h:230
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
PCIe/Ethernet DAQ diagnostic fields.
Definition AxsunCommonEnums.h:359
float fpga_temp
Definition AxsunCommonEnums.h:360
uint16_t error_status
Definition AxsunCommonEnums.h:368
uint16_t pipeline_monitor
Definition AxsunCommonEnums.h:367
float aux_temp
Definition AxsunCommonEnums.h:361
float vcc_int
Definition AxsunCommonEnums.h:364
uint64_t rfu
Definition AxsunCommonEnums.h:369
float adc_temp
Definition AxsunCommonEnums.h:362
float fan_speed
Definition AxsunCommonEnums.h:366
float i_fpga_core
Definition AxsunCommonEnums.h:363
float vcc_aux
Definition AxsunCommonEnums.h:365
Parameters for calculating a complex-valued window function with phase described using a Taylor serie...
Definition AxsunCommonEnums.h:347
float a2
Definition AxsunCommonEnums.h:354
float a3
Definition AxsunCommonEnums.h:355
uint32_t window_width
Definition AxsunCommonEnums.h:350
AxWindowFuncType type
Definition AxsunCommonEnums.h:348
uint32_t right_shift
Definition AxsunCommonEnums.h:352
uint32_t padded_width
Definition AxsunCommonEnums.h:351
float type_modifier
Definition AxsunCommonEnums.h:349
float a1
Definition AxsunCommonEnums.h:353