OpenScanDeviceLib
OpenScan Device Programming Interface
Data Fields
OScDevInternal_Interface Struct Reference

Interface function table for module to call OpenScanLib. More...

#include <OpenScanDeviceLib.h>

Data Fields

bool(* Acquisition_CallFrameCallback )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, uint32_t channel, void *pixels)
 
OScDev_Error(* Acquisition_GetClockSource )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, OScDev_ClockSource *clock)
 
OScDev_Error(* Acquisition_GetClockStartTriggerSource )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, OScDev_TriggerSource *startTrigger)
 
uint32_t(* Acquisition_GetNumberOfFrames )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)
 
double(* Acquisition_GetPixelRate )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)
 
uint32_t(* Acquisition_GetResolution )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)
 
void(* Acquisition_GetROI )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, uint32_t *xOffset, uint32_t *yOffset, uint32_t *width, uint32_t *height)
 
double(* Acquisition_GetZoomFactor )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)
 
OScDev_Error(* Acquisition_IsClockRequested )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)
 
OScDev_Error(* Acquisition_IsDetectorRequested )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)
 
OScDev_Error(* Acquisition_IsScannerRequested )(OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)
 
OScDev_Error(* Device_Create )(OScDev_ModuleImpl *modImpl, OScDev_Device **device, OScDev_DeviceImpl *impl, void *data)
 
void *(* Device_GetImplData )(OScDev_ModuleImpl *modImpl, OScDev_Device *device)
 
OScDev_RichError *(* Error_AsRichError )(OScDev_ModuleImpl *modImpl, OScDev_Error code)
 
OScDev_RichError *(* Error_Create )(OScDev_ModuleImpl *modImpl, const char *message)
 
OScDev_RichError *(* Error_CreateWithCode )(OScDev_ModuleImpl *modImpl, const char *domainName, OScDev_Error code, const char *message)
 
void(* Error_Destroy )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
void(* Error_Format )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error, char *buffer, size_t bufsize)
 
void(* Error_FormatRecursive )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error, char *buffer, size_t bufsize)
 
OScDev_RichError *(* Error_GetCause )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
int32_t(* Error_GetCode )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
const char *(* Error_GetDomain )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
const char *(* Error_GetMessage )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
OScDev_RichError *(* Error_RegisterCodeDomain )(OScDev_ModuleImpl *modImpl, const char *domainName, OScDev_ErrorCodeFormat codeFormat)
 
OScDev_Error(* Error_ReturnAsCode )(OScDev_ModuleImpl *modImpl, OScDev_RichError *error)
 
OScDev_RichError *(* Error_Wrap )(OScDev_ModuleImpl *modImpl, OScDev_RichError *cause, const char *message)
 
OScDev_RichError *(* Error_WrapWithCode )(OScDev_ModuleImpl *modImpl, OScDev_RichError *cause, const char *domainName, int32_t code, const char *message)
 
void(* Log )(OScDev_ModuleImpl *modImpl, OScDev_Device *device, OScDev_LogLevel level, const char *message)
 
void(* NumArray_Append )(OScDev_ModuleImpl *modImpl, OScDev_NumArray *arr, double val)
 
double(* NumArray_At )(OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr, size_t index)
 
OScDev_NumArray *(* NumArray_Create )(OScDev_ModuleImpl *modImpl)
 
OScDev_NumArray *(* NumArray_CreateFromNaNTerminated )(OScDev_ModuleImpl *modImpl, const double *nanTerminatedArray)
 
void(* NumArray_Destroy )(OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)
 
bool(* NumArray_Empty )(OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)
 
size_t(* NumArray_Size )(OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)
 
void(* NumRange_AppendDiscrete )(OScDev_ModuleImpl *modImpl, OScDev_NumRange *range, double val)
 
OScDev_NumRange *(* NumRange_CreateContinuous )(OScDev_ModuleImpl *modImpl, double rMin, double rMax)
 
OScDev_NumRange *(* NumRange_CreateDiscrete )(OScDev_ModuleImpl *modImpl)
 
OScDev_NumRange *(* NumRange_CreateDiscreteFromNaNTerminated )(OScDev_ModuleImpl *modImpl, const double *nanTerminatedArray)
 
void(* NumRange_Destroy )(OScDev_ModuleImpl *modImpl, const OScDev_NumRange *range)
 
void(* PtrArray_Append )(OScDev_ModuleImpl *modImpl, OScDev_PtrArray *arr, void *obj)
 
void *(* PtrArray_At )(OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr, size_t index)
 
OScDev_PtrArray *(* PtrArray_Create )(OScDev_ModuleImpl *modImpl)
 
OScDev_PtrArray *(* PtrArray_CreateFromNullTerminated )(OScDev_ModuleImpl *modImpl, void *const *nullTerminatedArray)
 
void(* PtrArray_Destroy )(OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)
 
bool(* PtrArray_Empty )(OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)
 
size_t(* PtrArray_Size )(OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)
 
OScDev_Error(* Setting_Create )(OScDev_ModuleImpl *modImpl, OScDev_Setting **setting, const char *name, OScDev_ValueType valueType, OScDev_SettingImpl *impl, void *data)
 
void(* Setting_Destroy )(OScDev_ModuleImpl *modImpl, OScDev_Setting *setting)
 
void *(* Setting_GetImplData )(OScDev_ModuleImpl *modImpl, OScDev_Setting *setting)
 

Detailed Description

Interface function table for module to call OpenScanLib.

The fields and layout of this struct must not be altered without a corresponding increment of the device interface version.

Definition at line 308 of file OpenScanDeviceLib.h.


The documentation for this struct was generated from the following file: