Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Rx::Interop::Runtime30::Camera::INativeDeviceControl Class Referenceabstract

Detailed Description

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

Public Member Functions

virtual void Close ()=0
 Executes a Close on this INativeDevice and the Device inside by use of the internal interface to the NativeDeviceDriver. More...
 
virtual void GetImageType (Rx::Interop::Runtime28::EPixelType::ID &ePixelType, Rx::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 GetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, float &fValue)=0
 Gets a property of type float. TODO: examples. More...
 
virtual void GetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, int &iValue)=0
 Gets a property of type int. TODO: examples More...
 
virtual int GetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, char *pcValue, int iMaxBufLen)=0
 Gets a property of type String. To obtain the buffer size needed, call this with pcValue = null. The size needed is the return value of this function. More...
 
virtual void GetPropertyRange (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, float &fMin, float &fMax)=0
 Gets the property range of the given property of type float. TODO: examples More...
 
virtual void GetPropertyRange (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, int &iMin, int &iMax)=0
 Gets the property range of the given property of type int. TODO: examples More...
 
virtual int GetPropertyRange (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, int *piValues, int iMaxValueCnt)=0
 Gets the propertyrange of the given arguments of type CRxArrayInt. This is only used for checking which trigger modes are supported by the camera. TODO: really? check this. More...
 
virtual bool IsPropertyAvailable (Rx::Interop::Runtime30::Camera::EProperty::ID eProp)=0
 Queries if a property is available. More...
 
virtual void Open ()=0
 Executes an Open on this INativeDevice and the Device inside by use of the internal interface to the NativeDeviceDriver. More...
 
virtual void SetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, float fValue)=0
 Sets a property of type float. TODO: examples More...
 
virtual void SetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, int iValue)=0
 Sets a property of type int. TODO: examples More...
 
virtual void SetProperty (Rx::Interop::Runtime30::Camera::EProperty::ID eProp, const char *pcValue)=0
 Sets a property of type Rx::CRxString. More...
 
virtual void StartCapture ()=0
 Starts the acquisition of iamges. This has to be called for image acquisition unrelated to the triggermode used. The triggermode has to be set while not capturing. More...
 
virtual void StopCapture ()=0
 Stops the acquisition of images. More...
 
virtual void SuspendCapture (bool bSuspend)=0
 Suspends the capturing. With most cameras this just pauses the passing of the images while other cameras implement a real suspend which saves energy. (e.g. Type C/IDS support real suspend) More...
 
virtual void Trigger ()=0
 Trigger image capture. In video mode it does nothing and returns true. In single capture mode performs a software trigger. Camera has to be open and should be capturing in software trigger mode. More...
 

Protected Member Functions

virtual ~INativeDeviceControl ()
 

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::Close ( )
pure virtual

Executes a Close on this INativeDevice and the Device inside by use of the internal interface to the NativeDeviceDriver.

Expected Device State: -Open

Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetImageType ( Rx::Interop::Runtime28::EPixelType::ID ePixelType,
Rx::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::INativeDeviceControl::GetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fValue 
)
pure virtual

Gets a property of type float. TODO: examples.

Parameters
eProp[in] The property in question.
fValue[out] The return value.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iValue 
)
pure virtual

Gets a property of type int. TODO: examples

Parameters
eProp[in] The property in question.
iValue[out] The return value.
Returns
True if it succeeds, false if it fails.
virtual int Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
char *  pcValue,
int  iMaxBufLen 
)
pure virtual

Gets a property of type String. To obtain the buffer size needed, call this with pcValue = null. The size needed is the return value of this function.

Parameters
eProp[in] The property in question.
pcValue[out] The buffer, receiving the property value.
iMaxBufLenLength of the pcValue buffer.
Returns
The number of chars, needed to store the resultig string in pcValue, including the terminating 0.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetPropertyRange ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fMin,
float &  fMax 
)
pure virtual

Gets the property range of the given property of type float. TODO: examples

Parameters
eProp[in] The property in question.
fMin[out] The minimum value for given property.
fMax[out] The maximum value for given property.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetPropertyRange ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iMin,
int &  iMax 
)
pure virtual

Gets the property range of the given property of type int. TODO: examples

Parameters
eProp[in] The property in question.
iMin[out] The minimum value for given property.
iMax[out] The maximum value for given property.
Returns
True if it succeeds, false if it fails.
virtual int Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetPropertyRange ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
int *  piValues,
int  iMaxValueCnt 
)
pure virtual

Gets the propertyrange of the given arguments of type CRxArrayInt. This is only used for checking which trigger modes are supported by the camera. TODO: really? check this.

Parameters
eProp[in] The property in question.
piValues[out] The pointer to an array that contains the list of available values. The pointer has to point to an array with iMaxValueCnt elements. The parameter iTotalValueCnt contains the total number of available properties. If a null pointer is passed here, only the total number of available parameters is returned in iTotalValueCnt.
iMaxValueCntMaximal number of values that can be stored in array pointed to by piValues.
Returns
[out] Total number of values.
virtual bool Rx::Interop::Runtime30::Camera::INativeDeviceControl::IsPropertyAvailable ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp)
pure virtual

Queries if a property is available.

Expected Devcie State:

  • Any (after Creation of the Device)
Parameters
eProp[in] The property in question.
Returns
True if the property is available, false if not.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::Open ( )
pure virtual

Executes an Open on this INativeDevice and the Device inside by use of the internal interface to the NativeDeviceDriver.

Expected Device State:

  • Initialized
Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
float  fValue 
)
pure virtual

Sets a property of type float. TODO: examples

Parameters
eProp[in] The property to be changed.
fValue[in] The value to be set.
Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
int  iValue 
)
pure virtual

Sets a property of type int. TODO: examples

Parameters
eProp[in] The property to be changed.
iValue[in] The value to be set.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty ( Rx::Interop::Runtime30::Camera::EProperty::ID  eProp,
const char *  pcValue 
)
pure virtual

Sets a property of type Rx::CRxString.

Parameters
ePropThe property to be changed.
pcValue[in] The value to be set.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::StartCapture ( )
pure virtual

Starts the acquisition of iamges. This has to be called for image acquisition unrelated to the triggermode used. The triggermode has to be set while not capturing.

Expected Device State:

  • Initialized
Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::StopCapture ( )
pure virtual

Stops the acquisition of images.

Expected Devcie State:

  • Capturing
Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SuspendCapture ( bool  bSuspend)
pure virtual

Suspends the capturing. With most cameras this just pauses the passing of the images while other cameras implement a real suspend which saves energy. (e.g. Type C/IDS support real suspend)

Expected Device State:

  • Capturing
Parameters
bSuspend[in] true to suspend.
Returns
True if it succeeds, false if it fails.
virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::Trigger ( )
pure virtual

Trigger image capture. In video mode it does nothing and returns true. In single capture mode performs a software trigger. Camera has to be open and should be capturing in software trigger mode.

Expected Devcie State:

  • Capturing
Returns
true if it succeeds, false if it fails.