Raytrix Light Field SDK  4.0
Logo
Public Member Functions | Protected Member Functions | List of all members
Rx::Interop::Runtime30::Camera::INativeDeviceDo Class Referenceabstract

Detailed Description

Interface for native device class. This base provides functionality for using devices independently of their hardware interface type.

For further information on these functions see the documentation for INativeDeviceControl!

Public Member Functions

virtual void DoClose ()=0
 Executes the close operation. Should only be called on an open Camera. For further information see DoOpen(). More...
 
virtual void DoDestroy ()=0
 Destroys this interface and by this the whole native device by deleting itself. More...
 
virtual void DoGetImageType (Interop::Runtime28::EPixelType::ID &ePixelType, Interop::Runtime28::EDataType::ID &eDataType, int &iBytesPerPixel)=0
 Gets information about the image type the camera delivers. This is done by getting the values from the manufacturer SDK and mapping them to Raytrix (enum) values. Example: case BGAPI_PIXTYPE_BAYGB8: { iPixelType = RX_IMG_BAYER_GB; iDataType = RX_IMG_UNSIGNED_BYTE; iBytesPerPixel = 1; break; } More...
 
virtual void DoGetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int &iValue)=0
 
virtual void DoGetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float &fValue)=0
 
virtual int DoGetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, char *pcValue, int iLen)=0
 
virtual void DoGetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, float &fMin, float &fMax)=0
 
virtual void DoGetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, int &iMin, int &iMax)=0
 
virtual int DoGetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, int *piValues, int iMaxValueCnt)=0
 
virtual void DoInitialize ()=0
 Executes the initialize operation. Has to be called before anything else after the construction. More...
 
virtual bool DoIsPropertyAvailable (Interop::Runtime30::Camera::EProperty::ID eProp)=0
 
virtual void DoOpen ()=0
 Executes the open operation. The Camera has to be initialized before. The device has to be open for some functions. With some cameras it doesn't do anything. Because it is called from the server side through the .NET device and native device the function will be called, because all cameras and states are handled equally. More...
 
virtual void DoRegisterImageCallback (Interop::Runtime30::Camera::INativeDeviceImageCallback *pNativeImageCallback)=0
 Registers the NativeDevice with the nativedevicedriver. It is used for ImageCallback and some checks. More...
 
virtual void DoSetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int iValue)=0
 
virtual void DoSetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float fValue)=0
 
virtual void DoSetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, const char *pcValue)=0
 
virtual void DoStartCapture (Interop::Runtime30::Camera::ETriggerMode::ID eProp)=0
 Executes the start capture operation. More...
 
virtual void DoStopCapture ()=0
 Executes the stop capture operation. More...
 
virtual void DoSuspendCapture (bool bSuspend)=0
 Executes the suspend capture operation. Should only be called on a device capturing images. Not all cameras support this, if the implementation is empty, but it will still be called from server side, where states are handled. More...
 
virtual void DoTrigger ()=0
 Executes the software trigger operation. More...
 

Protected Member Functions

virtual ~INativeDeviceDo ()
 

Constructor & Destructor Documentation

virtual Rx::Interop::Runtime30::Camera::INativeDeviceDo::~INativeDeviceDo ( )
inlineprotectedvirtual

Member Function Documentation

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoClose ( )
pure virtual

Executes the close operation. Should only be called on an open Camera. For further information see DoOpen().

Expected Device State:

  • Opened.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoDestroy ( )
pure virtual

Destroys this interface and by this the whole native device by deleting itself.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetImageType ( Interop::Runtime28::EPixelType::ID ePixelType,
Interop::Runtime28::EDataType::ID eDataType,
int &  iBytesPerPixel 
)
pure virtual

Gets information about the image type the camera delivers. This is done by getting the values from the manufacturer SDK and mapping them to Raytrix (enum) values. Example: case BGAPI_PIXTYPE_BAYGB8: { iPixelType = RX_IMG_BAYER_GB; iDataType = RX_IMG_UNSIGNED_BYTE; iBytesPerPixel = 1; break; }

Expected Device State:

  • Initialized
Parameters
ePixelType[out] The pixeltype.
eDataType[out] The datatype.
iBytesPerPixel[out] Zero-based index of the bytes per pixel.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iValue 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fValue 
)
pure virtual
virtual int Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
char *  pcValue,
int  iLen 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fMin,
float &  fMax 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iMin,
int &  iMax 
)
pure virtual
virtual int Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoGetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int *  piValues,
int  iMaxValueCnt 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoInitialize ( )
pure virtual

Executes the initialize operation. Has to be called before anything else after the construction.

Expected Device State:

  • Created (after construction)
virtual bool Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoIsPropertyAvailable ( Interop::Runtime30::Camera::EProperty::ID  eProp)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoOpen ( )
pure virtual

Executes the open operation. The Camera has to be initialized before. The device has to be open for some functions. With some cameras it doesn't do anything. Because it is called from the server side through the .NET device and native device the function will be called, because all cameras and states are handled equally.

Expected Device State:

  • Initialized.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoRegisterImageCallback ( Interop::Runtime30::Camera::INativeDeviceImageCallback pNativeImageCallback)
pure virtual

Registers the NativeDevice with the nativedevicedriver. It is used for ImageCallback and some checks.

Parameters
pNativeImageCallback[in] The native (device) base.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoSetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int  iValue 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoSetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float  fValue 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoSetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
const char *  pcValue 
)
pure virtual
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoStartCapture ( Interop::Runtime30::Camera::ETriggerMode::ID  eProp)
pure virtual

Executes the start capture operation.

Expected Device State:

  • Opened
Parameters
ePropThe triggermode the camera is to be started in. (e.g. live, snapshot)
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoStopCapture ( )
pure virtual

Executes the stop capture operation.

Expected Device State:

  • Capturing
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoSuspendCapture ( bool  bSuspend)
pure virtual

Executes the suspend capture operation. Should only be called on a device capturing images. Not all cameras support this, if the implementation is empty, but it will still be called from server side, where states are handled.

Expected Device State:

  • Capturing
Parameters
bSuspendtrue to suspend.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceDo::DoTrigger ( )
pure virtual

Executes the software trigger operation.

Expected Device State:

  • Capturing (with Software Trigger Mode)