AxsunOCTCapture  3.6.0.0
Captures and buffers streamed imaged data from the Axsun Ethernet/PCIe DAQ and displays or retrieves images to a client application on request.
Data Structures | Macros | Typedefs | Enumerations
AxsunCommonEnums.h File Reference

This header file contains enums and other definitions for integrating AxsunOCTCapture.dll and AxsunOCTControl_LW.dll into a client application. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  axtimeval_t
 Structure for packet time stamp with platform-independent size (for internal use.) More...
 

Macros

#define AXSUN_EXPORTS   __attribute__((visibility("default")))
 
#define __cdecl
 

Typedefs

typedef struct axtimeval_t axtimeval_t
 Structure for packet time stamp with platform-independent size (for internal use.)
 
typedef enum AxErr AxErr
 Error codes returned from AxsunOCTCapture or AxsunOCTControl_LW functions. Use axGetErrorString() in AxsunOCTCapture or axGetErrorExplained() in AxsunOCTControl_LW for descriptions.
 
typedef enum AxPipelineMode AxPipelineMode
 DAQ pipeline modes.
 
typedef enum AxChannelMode AxChannelMode
 DAQ channel selection modes.
 
typedef enum AxDataType AxDataType
 Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode.
 

Enumerations

enum  AxErr {
  NO_AxERROR = 0, UNKNOWN_ERROR = -10004, INVALID_ARGUMENTS = -10007, CAPABILITY_NOT_SUPPORTED = -10009,
  UNDEFINED_BOARD_TYPE = -10013, CAPTURE_SESSION_NOT_SETUP = -5000, CAPTURE_SESSION_ALREADY_DESTROYED = -5001, CAPTURE_INTERFACE_SETUP_FAILURE = -5002,
  CAPTURE_SESSION_HANDLE_INVALID = -5003, CALLBACK_NOT_REGISTERED = -5004, BUFFER_UNINITIALIZED = -5020, BUFFER_ALLOCATION_FAILURE = -5021,
  BUFFER_IS_EMPTY = -5022, BUFFER_BYTE_ALLIGNMENT_ERROR = -5023, DATA_RATE_MEASUREMENT_FAILURE = -5024, BUFFER_TOO_SMALL = -5025,
  BUFFER_BUSY = -5026, FILE_INCORRECT_TYPE = -5040, FILE_IDENTIFIER_NOT_READ = -5041, FILE_OPEN_FAILURE = -5042,
  FILE_CREATION_FAILURE = -5043, FILE_WRITING_FAILURE = -5044, FILE_PATHNAME_TOO_LONG = -5045, NOT_ALLOWED_WHILE_IMAGING = -5046,
  DATA_TYPE_NOT_SUPPORTED = -5047, FILE_READING_FAILURE = -5048, JPEG_LOAD_LIBRARY_FAILED = -5050, JPEG_LOAD_FUNCTION_FAILED = -5051,
  JPEG_INIT_FAILED = -5052, JPEG_DECOMPRESSION_ERROR = -5053, JPEG_COMPRESSION_ERROR = -5054, BMP_WRITING_FAILURE = -5055,
  OPENCV_LOAD_LIBRARY_FAILED = -5056, IMAGE_EXPORT_RESOURCES_MISSING = -5057, DAQMX_LOAD_LIBRARY_FAILED = -9000, DAQMX_LOAD_FUNCTION_FAILED = -9001,
  DAQMX_GET_INFO_FAILED = -9002, DAQMX_RESET_FAILED = -9003, DAQMX_TASK_CREATION_FAILED = -9004, DAQMX_CONFIGURATION_FAILED = -9005,
  DAQMX_INVALID_SCAN_PARAMS = -9006, DAQMX_MAX_VOLTAGE_EXCEEDED = -9007, DAQMX_COMMAND_DEPRECATED = -9009, DAQMX_BURST_RASTER_NOT_SETUP = -9010,
  DAQMX_COMMAND_NOT_RECOGNIZED = -9011, DAQMX_WAIT_TIMEOUT = -9012, DAQMX_MUTEX_TIMEOUT = -9013, DAQMX_UNSUPPORTED_DEVICE = -9014,
  DAQMX_DEVICE_NOT_FOUND = -9015, DAQMX_ALREADY_DESTROYED = -9016, RENDER_MODULE_HANDLE_UNAVAILABLE = -8000, RENDER_WINDOW_CLASS_REGISTRATION_FAILED = -8001,
  RENDER_WINDOW_CREATION_FAILED = -8002, RENDER_DEVICE_CONTEXT_CREATION_FAILED = -8003, RENDER_PIXEL_SETUP_FAILED = -8004, RENDER_CONTEXT_CREATION_FAILED = -8005,
  RENDER_GLEW_INIT_FAILED = -8006, RENDER_CONTEXT_CURRENT_FAILURE = -8007, RENDER_OPENGL_VERSION_UNSUPPORTED = -8008, RENDER_SHADER_PROGRAM_FAILED = -8009,
  RENDER_WAITING_FOR_THREAD = -8010, RENDER_THREAD_NOT_RESPONDING = -8011, RENDER_OPENGL_FUNCTION_ERROR = -8012, RENDER_FUNCTIONS_NOT_SETUP = -8013,
  RENDER_WINDOW_MOVE_FAILED = -8014, RENDER_WINDOW_STYLE_FAILED = -8015, RENDER_WINDOW_NOT_SETUP = -8016, PCAP_LOAD_LIBRARY_FAILED = -7000,
  PCAP_LOAD_FUNCTION_FAILED = -7001, PCAP_NO_DEVICES_FOUND = -7002, PCAP_INTERNAL_ERROR = -7003, PCAP_DEVICE_OPEN_FAILURE = -7004,
  PCAP_DEVICE_SETUP_FAILURE = -7005, PCIE_LOAD_LIBRARY_FAILED = -7020, PCIE_LOAD_FUNCTION_FAILED = -7021, PCIE_INTERFACE_NOT_SETUP = -7022,
  PCIE_DEVICE_SETUP_FAILURE = -7023, PCIE_DRIVER_SETUP_FAILURE = -7024, PCIE_DAQ_NOT_INSTALLED = -7025, PCIE_DAQ_INFO_UNAVAILABLE = -7026,
  PCIE_DEVICE_OPEN_FAILURE = -7027, PCIE_BUFFER_LOCK_FAILURE = -7028, PCIE_WRITE_REGISTER_FAILURE = -7029, PCIE_READ_REGISTER_FAILURE = -7030,
  PCIE_SYNC_IO_FAILURE = -7031, PCIE_INTERRUPT_ENABLE_FAILURE = -7032, AQDAQ_LOAD_LIBRARY_FAILED = -7033, AQDAQ_LOAD_FUNCTION_FAILED = -7034,
  AQDAQ_FUNCTION_ERROR = -7035, AQDAQ_NO_IMAGE_AVAILABLE = -7036, DATA_INDEX_INVALID = -9991, DATA_NOT_COMPRESSED = -9992,
  DATA_TYPE_OR_LENGTH_CHANGED = -9993, DATA_ALLOCATION_TOO_SMALL = -9994, DATA_INCOMPLETE_OR_MISSING = -9996, DATA_RETURNED_IN_PREVIOUS_REQUEST = -9997,
  DATA_NOT_FOUND_IN_BUFFER = -9999, UNINITIALIZED = -10001, CANCELLED_BY_USER = -10002, COMMAND_NOT_IMPLEMENTED = -10003,
  ALREADY_INITIALIZED = -10005, INSUFFICIENT_ALLOCATION = -10006, DATA_VALIDATION_FAILED = -10008, COMMUNICATION_ERROR = -10010,
  COMMAND_NOT_RECOGNIZED = -55, USB_CHECKSUM_ERROR = -104, PAYLOAD_CHECKSUM_ERROR = -108, CANNOT_START_TEC_IN_ERROR = -126,
  INVALID_CONFIG_PARAMS = -138, CONFIG_NOT_SETUP = -140, USB_READ_ERROR = -1000, USB_WRITE_ERROR = -1001,
  NO_DEVICE_PRESENT = -1002, TCP_READ_ERROR = -1020, TCP_WRITE_ERROR = -1021, TCP_CONNECT_ERROR = -1022,
  SERIAL_READ_ERROR = -1025, SERIAL_WRITE_ERROR = -10250, DATA_SIZE_TOO_BIG = -1029, HOSTSIDE_USB_ERROR = -1033,
  USB_COMMUNICATION_ERROR = -1038, MUTEX_TIMEOUT = -1039, DAC_TABLE_NOT_LOADED = -1048, USB_LOAD_LIBRARY_FAILED = -10011,
  USB_LOAD_FUNCTION_FAILED = -10012
}
 Error codes returned from AxsunOCTCapture or AxsunOCTControl_LW functions. Use axGetErrorString() in AxsunOCTCapture or axGetErrorExplained() in AxsunOCTControl_LW for descriptions.
 
enum  AxPipelineMode {
  UNKNOWN = 0, RAW_ADC = 1, WINDOWED = 2, IFFT = 3,
  MOD_SQUARED = 4, SQRT = 5, LOG = 6, EIGHT_BIT = 7,
  JPEG_COMP = 8, PIPELINEMODE_RFU = 9
}
 DAQ pipeline modes. More...
 
enum  AxChannelMode {
  CHAN_1 = 0, CHAN_2 = 1, SUM_CHANNELS = 2, INTERLEAVE_CHANNELS = 3,
  CHANNELMODE_RFU = 4
}
 DAQ channel selection modes. More...
 
enum  AxDataType {
  U8, U16, U32, CMPLX,
  I16, U16_le, U32_le, CMPLX_le,
  I16_le, I32_le, AXDATATYPE_RFU
}
 Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode. More...
 

Detailed Description

This header file contains enums and other definitions for integrating AxsunOCTCapture.dll and AxsunOCTControl_LW.dll into a client application.

Enumeration Type Documentation

◆ AxChannelMode

DAQ channel selection modes.

Enumerator
CHAN_1 

Channel 1 only.

CHAN_2 

Channel 2 only.

SUM_CHANNELS 

Channels 1 and 2 mixed using vector sum (e.g. polarization diverse).

INTERLEAVE_CHANNELS 

Channels 1 and 2 interleaved.

CHANNELMODE_RFU 

Reserved for future use.

◆ AxDataType

enum AxDataType

Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode.

Enumerator
U8 

Unsigned 8-bit.

U16 

Unsigned 16-bit, big endian.

U32 

Unsigned 32-bit, big endian.

CMPLX 

32-bit complex (Signed 16-bit imaginary, Signed 16-bit real), big endian.

I16 

Signed 16-bit, big endian.

U16_le 

Unsigned 16-bit, little endian.

U32_le 

Unsigned 32-bit, little endian.

CMPLX_le 

32-bit complex (Signed 16-bit imaginary, Signed 16-bit real), little endian.

I16_le 

Signed 16-bit, little endian.

I32_le 

Signed 32-bit, little endian.

AXDATATYPE_RFU 

(reserved for future use).

◆ AxPipelineMode

DAQ pipeline modes.

Enumerator
UNKNOWN 

Undefined mode (invalid value in FPGA Register 61?).

RAW_ADC 

Sampled data directly from ADC (unprocessed).

WINDOWED 

After windowing and zero-padding.

IFFT 

After calculation of Fourier transformation and negative frequency truncation.

MOD_SQUARED 

After calculation of complex modulus squared.

SQRT 

After calculation of square root and background subtraction.

LOG 

After logarithmic compression.

EIGHT_BIT 

After dynamic-range compression to 8-bits.

JPEG_COMP 

After JPEG compression (Ethernet interface only).

PIPELINEMODE_RFU 

Reserved for future use.