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.

Field Documentation

◆ Log

void(* Log) (OScDev_ModuleImpl *modImpl, OScDev_Device *device, OScDev_LogLevel level, const char *message)

Definition at line 312 of file OpenScanDeviceLib.h.

◆ Error_RegisterCodeDomain

OScDev_RichError *(* Error_RegisterCodeDomain) (OScDev_ModuleImpl *modImpl, const char *domainName, OScDev_ErrorCodeFormat codeFormat)

Definition at line 315 of file OpenScanDeviceLib.h.

◆ Error_ReturnAsCode

OScDev_Error(* Error_ReturnAsCode) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 318 of file OpenScanDeviceLib.h.

◆ Error_Create

OScDev_RichError *(* Error_Create) (OScDev_ModuleImpl *modImpl, const char *message)

Definition at line 320 of file OpenScanDeviceLib.h.

◆ Error_CreateWithCode

OScDev_RichError *(* Error_CreateWithCode) (OScDev_ModuleImpl *modImpl, const char *domainName, OScDev_Error code, const char *message)

Definition at line 322 of file OpenScanDeviceLib.h.

◆ Error_Wrap

OScDev_RichError *(* Error_Wrap) (OScDev_ModuleImpl *modImpl, OScDev_RichError *cause, const char *message)

Definition at line 326 of file OpenScanDeviceLib.h.

◆ Error_WrapWithCode

OScDev_RichError *(* Error_WrapWithCode) (OScDev_ModuleImpl *modImpl, OScDev_RichError *cause, const char *domainName, int32_t code, const char *message)

Definition at line 329 of file OpenScanDeviceLib.h.

◆ Error_GetMessage

const char *(* Error_GetMessage) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 334 of file OpenScanDeviceLib.h.

◆ Error_GetDomain

const char *(* Error_GetDomain) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 336 of file OpenScanDeviceLib.h.

◆ Error_GetCode

int32_t(* Error_GetCode) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 338 of file OpenScanDeviceLib.h.

◆ Error_GetCause

OScDev_RichError *(* Error_GetCause) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 340 of file OpenScanDeviceLib.h.

◆ Error_Format

void(* Error_Format) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error, char *buffer, size_t bufsize)

Definition at line 342 of file OpenScanDeviceLib.h.

◆ Error_FormatRecursive

void(* Error_FormatRecursive) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error, char *buffer, size_t bufsize)

Definition at line 344 of file OpenScanDeviceLib.h.

◆ Error_AsRichError

OScDev_RichError *(* Error_AsRichError) (OScDev_ModuleImpl *modImpl, OScDev_Error code)

Definition at line 347 of file OpenScanDeviceLib.h.

◆ Error_Destroy

void(* Error_Destroy) (OScDev_ModuleImpl *modImpl, OScDev_RichError *error)

Definition at line 349 of file OpenScanDeviceLib.h.

◆ PtrArray_Create

OScDev_PtrArray *(* PtrArray_Create) (OScDev_ModuleImpl *modImpl)

Definition at line 351 of file OpenScanDeviceLib.h.

◆ PtrArray_CreateFromNullTerminated

OScDev_PtrArray *(* PtrArray_CreateFromNullTerminated) (OScDev_ModuleImpl *modImpl, void *const *nullTerminatedArray)

Definition at line 352 of file OpenScanDeviceLib.h.

◆ PtrArray_Destroy

void(* PtrArray_Destroy) (OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)

Definition at line 354 of file OpenScanDeviceLib.h.

◆ PtrArray_Append

void(* PtrArray_Append) (OScDev_ModuleImpl *modImpl, OScDev_PtrArray *arr, void *obj)

Definition at line 356 of file OpenScanDeviceLib.h.

◆ PtrArray_Size

size_t(* PtrArray_Size) (OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)

Definition at line 358 of file OpenScanDeviceLib.h.

◆ PtrArray_Empty

bool(* PtrArray_Empty) (OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr)

Definition at line 360 of file OpenScanDeviceLib.h.

◆ PtrArray_At

void *(* PtrArray_At) (OScDev_ModuleImpl *modImpl, const OScDev_PtrArray *arr, size_t index)

Definition at line 362 of file OpenScanDeviceLib.h.

◆ NumArray_Create

OScDev_NumArray *(* NumArray_Create) (OScDev_ModuleImpl *modImpl)

Definition at line 365 of file OpenScanDeviceLib.h.

◆ NumArray_CreateFromNaNTerminated

OScDev_NumArray *(* NumArray_CreateFromNaNTerminated) (OScDev_ModuleImpl *modImpl, const double *nanTerminatedArray)

Definition at line 366 of file OpenScanDeviceLib.h.

◆ NumArray_Destroy

void(* NumArray_Destroy) (OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)

Definition at line 368 of file OpenScanDeviceLib.h.

◆ NumArray_Append

void(* NumArray_Append) (OScDev_ModuleImpl *modImpl, OScDev_NumArray *arr, double val)

Definition at line 370 of file OpenScanDeviceLib.h.

◆ NumArray_Size

size_t(* NumArray_Size) (OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)

Definition at line 372 of file OpenScanDeviceLib.h.

◆ NumArray_Empty

bool(* NumArray_Empty) (OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr)

Definition at line 374 of file OpenScanDeviceLib.h.

◆ NumArray_At

double(* NumArray_At) (OScDev_ModuleImpl *modImpl, const OScDev_NumArray *arr, size_t index)

Definition at line 376 of file OpenScanDeviceLib.h.

◆ NumRange_CreateContinuous

OScDev_NumRange *(* NumRange_CreateContinuous) (OScDev_ModuleImpl *modImpl, double rMin, double rMax)

Definition at line 379 of file OpenScanDeviceLib.h.

◆ NumRange_CreateDiscrete

OScDev_NumRange *(* NumRange_CreateDiscrete) (OScDev_ModuleImpl *modImpl)

Definition at line 381 of file OpenScanDeviceLib.h.

◆ NumRange_CreateDiscreteFromNaNTerminated

OScDev_NumRange *(* NumRange_CreateDiscreteFromNaNTerminated) (OScDev_ModuleImpl *modImpl, const double *nanTerminatedArray)

Definition at line 382 of file OpenScanDeviceLib.h.

◆ NumRange_Destroy

void(* NumRange_Destroy) (OScDev_ModuleImpl *modImpl, const OScDev_NumRange *range)

Definition at line 384 of file OpenScanDeviceLib.h.

◆ NumRange_AppendDiscrete

void(* NumRange_AppendDiscrete) (OScDev_ModuleImpl *modImpl, OScDev_NumRange *range, double val)

Definition at line 386 of file OpenScanDeviceLib.h.

◆ Device_Create

OScDev_Error(* Device_Create) (OScDev_ModuleImpl *modImpl, OScDev_Device **device, OScDev_DeviceImpl *impl, void *data)

Definition at line 389 of file OpenScanDeviceLib.h.

◆ Device_GetImplData

void *(* Device_GetImplData) (OScDev_ModuleImpl *modImpl, OScDev_Device *device)

Definition at line 392 of file OpenScanDeviceLib.h.

◆ Setting_Create

OScDev_Error(* Setting_Create) (OScDev_ModuleImpl *modImpl, OScDev_Setting **setting, const char *name, OScDev_ValueType valueType, OScDev_SettingImpl *impl, void *data)

Definition at line 395 of file OpenScanDeviceLib.h.

◆ Setting_Destroy

void(* Setting_Destroy) (OScDev_ModuleImpl *modImpl, OScDev_Setting *setting)

Definition at line 399 of file OpenScanDeviceLib.h.

◆ Setting_GetImplData

void *(* Setting_GetImplData) (OScDev_ModuleImpl *modImpl, OScDev_Setting *setting)

Definition at line 401 of file OpenScanDeviceLib.h.

◆ Acquisition_IsClockRequested

OScDev_Error(* Acquisition_IsClockRequested) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)

Definition at line 405 of file OpenScanDeviceLib.h.

◆ Acquisition_IsScannerRequested

OScDev_Error(* Acquisition_IsScannerRequested) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)

Definition at line 408 of file OpenScanDeviceLib.h.

◆ Acquisition_IsDetectorRequested

OScDev_Error(* Acquisition_IsDetectorRequested) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, bool *isRequested)

Definition at line 411 of file OpenScanDeviceLib.h.

◆ Acquisition_GetClockStartTriggerSource

OScDev_Error(* Acquisition_GetClockStartTriggerSource) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, OScDev_TriggerSource *startTrigger)

Definition at line 414 of file OpenScanDeviceLib.h.

◆ Acquisition_GetClockSource

OScDev_Error(* Acquisition_GetClockSource) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, OScDev_ClockSource *clock)

Definition at line 417 of file OpenScanDeviceLib.h.

◆ Acquisition_GetNumberOfFrames

uint32_t(* Acquisition_GetNumberOfFrames) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)

Definition at line 421 of file OpenScanDeviceLib.h.

◆ Acquisition_GetPixelRate

double(* Acquisition_GetPixelRate) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)

Definition at line 423 of file OpenScanDeviceLib.h.

◆ Acquisition_GetResolution

uint32_t(* Acquisition_GetResolution) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)

Definition at line 425 of file OpenScanDeviceLib.h.

◆ Acquisition_GetZoomFactor

double(* Acquisition_GetZoomFactor) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq)

Definition at line 427 of file OpenScanDeviceLib.h.

◆ Acquisition_GetROI

void(* Acquisition_GetROI) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, uint32_t *xOffset, uint32_t *yOffset, uint32_t *width, uint32_t *height)

Definition at line 429 of file OpenScanDeviceLib.h.

◆ Acquisition_CallFrameCallback

bool(* Acquisition_CallFrameCallback) (OScDev_ModuleImpl *modImpl, OScDev_Acquisition *acq, uint32_t channel, void *pixels)

Definition at line 434 of file OpenScanDeviceLib.h.

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

/home/runner/work/OpenScanLib/OpenScanLib/OpenScanDeviceLib/include/OpenScanDeviceLib.h

Data Fields