![]() |
Raytrix RayCam SDK
v2.1.0
|
Driver class initializes the driver and checks for connected and valid devices. You can search for devices, create or delete devices. More...
#include <IDriver.h>
Public Member Functions | |
virtual IDevice * | CreateDevice (int iIdx)=0 |
Creates a device. Index represents the device attachment order. More... | |
virtual IDevice * | CreateDevice (const char *pcSerial)=0 |
Creates a devic with the given serial number. More... | |
virtual void | DestroyDevice (IDevice *pDevice)=0 |
Destroys the Rx::RayCam::IDevice described by pDevice. More... | |
virtual void | DiscoverDevices (int &iDeviceCount)=0 |
Discovers devices and returns the total count of all devices. More... | |
virtual void | DiscoverDevicesAsync ()=0 |
Discover devices asynchronous. For each Device discovered, you will receive a callback invocation of the Plug and Play Connect callback (use RegisterPnPConnectCallback() to register a callback) More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, int &theValue)=0 |
Gets a driver property of type int. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, double &theValue)=0 |
Gets a driver property of type double. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, long long &theValue)=0 |
Gets a driver property of type int. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, int &theValue, int &theValue2)=0 |
Gets a driver property of type int. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, double &theValue, double &theValue2)=0 |
Gets a driver property of type double. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, long long &theValue, long long &theValue2)=0 |
Gets a driver property of type int. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, void *theValue, int &theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, char *theValue, int &theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | GetProperty (EDriverProperty::ID eProp, wchar_t *theValue, int &theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | GetPropertyRange (EDriverProperty::ID eProp, int &newMinValue, int &newMaxValue)=0 |
Gets a driver property of type int. More... | |
virtual void | GetPropertyRange (EDriverProperty::ID eProp, double &newMinValue, double &newMaxValue)=0 |
Gets a driver property of type double. More... | |
virtual void | GetPropertyRange (EDriverProperty::ID eProp, long long &newMinValue, long long &newMaxValue)=0 |
Gets a driver property of type int. More... | |
virtual void | HasProperty (EDriverProperty::ID eProp)=0 |
Check if a property is available for Get/Set operations. More... | |
virtual void | InitDriver (void)=0 |
Initializes the driver. Only in case of success it is safe to proceed with e.g. DiscoverDevices(iDeviceCount). More... | |
virtual void | InitDriver (void *pvErrorCallBackOwner, TErrorCallback fErrorCallback)=0 |
Initializes the driver. Only in case of success it is safe to proceed with e.g. DiscoverDevices(iDeviceCount). More... | |
virtual void | RegisterErrorCallback (void *callBackOwner, TErrorCallback fErrorCallback)=0 |
Registers the error callback. More... | |
virtual void | RegisterPnpConnectCallback (void *callBackOwner, TCallbackFunctionPnpConnect pCallbackFunction)=0 |
Registers the callback pnp connect. After registering connect callback, you also have to register the disconnect callback. If you register a PnP callback function, you'll get a callback each time a new camera has been connected computer. More... | |
virtual void | RegisterPnpDisconnectCallback (void *callBackOwner, TCallbackFunctionPnpDisconnect pCallbackFunction)=0 |
Registers the callback pnp disconnect. After registering disconnect callback, you also have to register the connect callback.If you register a PnP callback function, you'll get a callback each time a new camera has been removed from the computer. You also HAVE to ensure that every device provided by the disconnect callback will be closed and also given back to the driver. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, int newValue)=0 |
Sets a driver property of type int. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, double newValue)=0 |
Sets a driver property of type double. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, long long newValue)=0 |
Sets a driver property of type int. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, int newValue, int newValue2)=0 |
Sets a driver property of type int. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, double newValue, double newValue2)=0 |
Sets a driver property of type double. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, long long newValue, long long newValue2)=0 |
Sets a driver property of type int. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, void *theValue, int theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, char *theValue, int theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | SetProperty (EDriverProperty::ID eProp, wchar_t *theValue, int theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | SetPropertyRange (EDriverProperty::ID eProp, int newMinValue, int newMaxValue)=0 |
Sets a driver property of type int. More... | |
virtual void | SetPropertyRange (EDriverProperty::ID eProp, double newMinValue, double newMaxValue)=0 |
Sets a driver property of type double. More... | |
virtual void | SetPropertyRange (EDriverProperty::ID eProp, long long newMinValue, long long newMaxValue)=0 |
Sets a driver property of type double. More... | |
virtual void | UnregisterErrorCallback (void)=0 |
Unregisters the error callback. More... | |
virtual void | UnregisterPnpConnectCallback (void)=0 |
Unregisters the callback pnp connect. More... | |
virtual void | UnregisterPnpDisconnectCallback (void)=0 |
Unregisters the callback pnp disconnect. More... | |
virtual int | UpdateCheck (Rx::RayCam::IDevice *pxCamera)=0 |
Checks for updates. More... | |
virtual void | UpdateFirmware (Rx::RayCam::IDevice *pxCamera)=0 |
Searches for updates and updates the camera firmware. This function call can take up to 2 minutes. More... | |
Driver class initializes the driver and checks for connected and valid devices. You can search for devices, create or delete devices.
|
pure virtual |
Creates a device. Index represents the device attachment order.
iIdx | Index, starting with zero. |
|
pure virtual |
Creates a devic with the given serial number.
pcSerial | [in] The serial number of the camera to create. |
|
pure virtual |
Destroys the Rx::RayCam::IDevice described by pDevice.
pDevice | [in,out] The device. |
|
pure virtual |
Discovers devices and returns the total count of all devices.
iDeviceCount | [in,out] Number of devices. |
|
pure virtual |
Discover devices asynchronous. For each Device discovered, you will receive a callback invocation of the Plug and Play Connect callback (use RegisterPnPConnectCallback() to register a callback)
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
theValue2 | [in,out] The second the value. |
|
pure virtual |
Gets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
theValue2 | [in,out] The second the value. |
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value. |
theValue2 | [in,out] The second the value. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | [in,out] Size of the buffer. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | [in,out] Size of the buffer. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | [in,out] Size of the buffer. |
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | [in,out] The value. |
newMaxValue | [in,out] The new maximum value. |
|
pure virtual |
Gets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | [in,out] The value. |
newMaxValue | [in,out] The new maximum value. |
|
pure virtual |
Gets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | [in,out] The value. |
newMaxValue | [in,out] The new maximum value. |
|
pure virtual |
Check if a property is available for Get/Set operations.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
|
pure virtual |
Initializes the driver. Only in case of success it is safe to proceed with e.g. DiscoverDevices(iDeviceCount).
|
pure virtual |
Initializes the driver. Only in case of success it is safe to proceed with e.g. DiscoverDevices(iDeviceCount).
|
pure virtual |
Registers the error callback.
callBackOwner | [in] If non-null, the owner of the callback. |
fErrorCallback | The error callback. |
|
pure virtual |
Registers the callback pnp connect. After registering connect callback, you also have to register the disconnect callback. If you register a PnP callback function, you'll get a callback each time a new camera has been connected computer.
callBackOwner | [in,out] If non-null, the owner of the call back. |
pCallbackFunction | The callback function. |
|
pure virtual |
Registers the callback pnp disconnect. After registering disconnect callback, you also have to register the connect callback.If you register a PnP callback function, you'll get a callback each time a new camera has been removed from the computer. You also HAVE to ensure that every device provided by the disconnect callback will be closed and also given back to the driver.
callBackOwner | [in,out] If non-null, the owner of the call back. |
pCallbackFunction | The callback function. |
|
pure virtual |
Sets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
|
pure virtual |
Sets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
|
pure virtual |
Sets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
|
pure virtual |
Sets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
newValue2 | The second new value. |
|
pure virtual |
Sets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
newValue2 | The second new value. |
|
pure virtual |
Sets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newValue | The new value. |
newValue2 | The second new value. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | Size of the buffer. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | Size of the buffer. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | Size of the buffer. |
|
pure virtual |
Sets a driver property of type int.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | The new value. |
newMaxValue | The new maximum value. |
|
pure virtual |
Sets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | The new value. |
newMaxValue | The new maximum value. |
|
pure virtual |
Sets a driver property of type double.
eProp | The Rx::RayCam::EDriverProperty::ID property. |
newMinValue | The new value. |
newMaxValue | The new maximum value. |
|
pure virtual |
Unregisters the error callback.
|
pure virtual |
Unregisters the callback pnp connect.
|
pure virtual |
Unregisters the callback pnp disconnect.
|
pure virtual |
Checks for updates.
pxCamera | [in] The camera you want to update. |
|
pure virtual |
Searches for updates and updates the camera firmware. This function call can take up to 2 minutes.
pxCamera | [in] The camera you want to update. |