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
	Closes the device and finalizes the communication. More...

virtual void	GetImageType (Interop::Runtime28::EPixelType::ID &ePixelType, Interop::Runtime28::EDataType::ID &eDataType, int &iBytesPerPixel)=0
	Gets information about the image type the camera delivers. The camera must be open before calling this function. More...

virtual void	GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float &fValue)=0
	Gets a property value of type float. More...

virtual void	GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int &iValue)=0
	Gets a property value of type int. More...

virtual int	GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, char *pcValue, int iBufferSize)=0
	Gets a property value of type string. More...

virtual void	GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, float &fMin, float &fMax)=0
	Gets the property value range of the given property of type float. More...

virtual void	GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, int &iMin, int &iMax)=0
	Gets the property value range of the given property of type int. More...

virtual int	GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, int *piValues, int iNumValues)=0
	Gets the property value range of the given arguments of type array int. More...

virtual bool	IsPropertyAvailable (Interop::Runtime30::Camera::EProperty::ID eProp)=0
	Queries if a property is available. More...

virtual void	Open ()=0
	Opens the device and prepares the communication. More...

virtual void	SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float fValue)=0
	Sets a property value of type float. More...

virtual void	SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int iValue)=0
	Sets a property value of type int. More...

virtual void	SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, const char *pcValue)=0
	Sets a property value of type string. More...

virtual void	StartCapture ()=0
	Starts the acquisition of images. More...

virtual void	StopCapture ()=0
	Stops the acquisition of images. More...

virtual void	SuspendCapture (bool bSuspend)=0
	Suspends the capturing. More...

virtual void	Trigger ()=0
	Triggers an image capture. 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

Closes the device and finalizes the communication.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetImageType	(	Interop::Runtime28::EPixelType::ID &	ePixelType,
		Interop::Runtime28::EDataType::ID &	eDataType,
		int &	iBytesPerPixel
	)

pure virtual

Gets information about the image type the camera delivers. The camera must be open before calling this function.

Parameters

ePixelType	[out] The pixeltype.
eDataType	[out] The datatype.
iBytesPerPixel	[out] The number of bytes per pixel.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		float &	fValue
	)

pure virtual

Gets a property value of type float.

Parameters

eProp	[in] The property in question.
fValue	[out] The return value.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		int &	iValue
	)

pure virtual

Gets a property value of type int.

Parameters

eProp	[in] The property in question.
iValue	[out] The return value.

virtual int Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		char *	pcValue,
		int	iBufferSize
	)

pure virtual

Gets a property value of type string.

To obtain the required buffer size, call this with pcValue = null.

Parameters

eProp	[in] The property in question.
pcValue	[out] The user managed buffer that is used for storing the value.
iBufferSize	The size of the given buffer in bytes.

Returns: The number of bytes that is required to store the resultig string in pcValue, including the terminating 0.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetPropertyRange	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		float &	fMin,
		float &	fMax
	)

pure virtual

Gets the property value range of the given property of type float.

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	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		int &	iMin,
		int &	iMax
	)

pure virtual

Gets the property value range of the given property of type int.

Parameters

eProp	[in] The property in question.
iMin	[out] The minimum value for given property.
iMax	[out] The maximum value for given property.

virtual int Rx::Interop::Runtime30::Camera::INativeDeviceControl::GetPropertyRange	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		int *	piValues,
		int	iNumValues
	)

pure virtual

Gets the property value range of the given arguments of type array int.

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.
iNumValues	The number of values that can be stored in piValues.

Returns: The number of integers that is required to store all available values.

virtual bool Rx::Interop::Runtime30::Camera::INativeDeviceControl::IsPropertyAvailable ( Interop::Runtime30::Camera::EProperty::ID eProp )

pure virtual

Queries if a property is available.

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

Opens the device and prepares the communication.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		float	fValue
	)

pure virtual

Sets a property value of type float.

Parameters

eProp	[in] The property to be changed.
fValue	[in] The value to be set.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		int	iValue
	)

pure virtual

Sets a property value of type int.

Parameters

eProp	[in] The property to be changed.
iValue	[in] The value to be set.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::SetProperty	(	Interop::Runtime30::Camera::EProperty::ID	eProp,
		const char *	pcValue
	)

pure virtual

Sets a property value of type string.

Parameters

eProp	The property to be changed.
pcValue	[in] The value to be set. This is a null terminated string.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::StartCapture ( )

pure virtual

Starts the acquisition of images.

This has to be called for image acquisition unrelated to the trigger mode used. The trigger mode has to be set while not capturing.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::StopCapture ( )

pure virtual

Stops the acquisition of images.

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.

Parameters

bSuspend [in] true to suspend.

virtual void Rx::Interop::Runtime30::Camera::INativeDeviceControl::Trigger ( )

pure virtual

Triggers an image capture.

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

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation