Skip to content

Class XiAPIWrapper

ClassList > XiAPIWrapper

This class provides a wrapper for the XiAPI library functions from XIMEA. It can also be overwritten with other implementations such as the Mocks created for unit testing this application.

  • #include <xiAPIWrapper.h>

Public Functions

Type Name
virtual int xiCloseDevice (IN HANDLE hDevice)
virtual int xiGetImage (IN HANDLE hDevice, IN DWORD timeout, OUT LPXI_IMG img)
virtual int xiGetNumberDevices (OUT PDWORD pNumberDevices)
virtual int xiGetParamFloat (IN HANDLE hDevice, const char * prm, float * val)
virtual int xiGetParamInt (IN HANDLE hDevice, const char * prm, int * val)
virtual int xiGetParamString (IN HANDLE hDevice, const char * prm, void * val, DWORD size)
virtual int xiOpenDevice (IN DWORD DevId, OUT PHANDLE hDevice)
virtual int xiSetParamFloat (IN HANDLE hDevice, const char * prm, const float val)
virtual int xiSetParamInt (IN HANDLE hDevice, const char * prm, const int val)
virtual int xiStartAcquisition (IN HANDLE hDevice)
virtual int xiStopAcquisition (IN HANDLE hDevice)
virtual ~XiAPIWrapper () = default

Public Functions Documentation

function xiCloseDevice

inline virtual int XiAPIWrapper::xiCloseDevice (
    IN HANDLE hDevice
)

function xiGetImage

inline virtual int XiAPIWrapper::xiGetImage (
    IN HANDLE hDevice,
    IN DWORD timeout,
    OUT LPXI_IMG img
)

function xiGetNumberDevices

inline virtual int XiAPIWrapper::xiGetNumberDevices (
    OUT PDWORD pNumberDevices
)

function xiGetParamFloat

inline virtual int XiAPIWrapper::xiGetParamFloat (
    IN HANDLE hDevice,
    const char * prm,
    float * val
)

function xiGetParamInt

inline virtual int XiAPIWrapper::xiGetParamInt (
    IN HANDLE hDevice,
    const char * prm,
    int * val
)

function xiGetParamString

inline virtual int XiAPIWrapper::xiGetParamString (
    IN HANDLE hDevice,
    const char * prm,
    void * val,
    DWORD size
)

function xiOpenDevice

inline virtual int XiAPIWrapper::xiOpenDevice (
    IN DWORD DevId,
    OUT PHANDLE hDevice
)

function xiSetParamFloat

inline virtual int XiAPIWrapper::xiSetParamFloat (
    IN HANDLE hDevice,
    const char * prm,
    const float val
)

function xiSetParamInt

inline virtual int XiAPIWrapper::xiSetParamInt (
    IN HANDLE hDevice,
    const char * prm,
    const int val
)

function xiStartAcquisition

inline virtual int XiAPIWrapper::xiStartAcquisition (
    IN HANDLE hDevice
)

function xiStopAcquisition

inline virtual int XiAPIWrapper::xiStopAcquisition (
    IN HANDLE hDevice
)

function ~XiAPIWrapper

virtual XiAPIWrapper::~XiAPIWrapper () = default

The documentation for this class was generated from the following file src/xiAPIWrapper.h