HDRControl Class Reference

A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only). More...

Inheritance diagram for HDRControl:

Public Member Functions
synchronized void	delete ()
PropertyI	getHDREnable ()
	An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.
HDRKneePoint	getHDRKneePoint (long nr)
	Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.
PropertyI	getHDRKneePointCount ()
	An integer property to define the number of knee points to work with when mvIMPACT.acquire.HDRControl.getHDRMode() is set to mvIMPACT.acquire.TCameraHDRMode.cHDRmUser.
PropertyI	getHDRMode ()
	An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.
	HDRControl (HDRControl src)
	Copy constructor.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
boolean	isAvailable ()
	This function should be called to check if this device offers HDR (High Dynamic Range) control parameters.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	HDRControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (HDRControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only).

Note

Not every device will offer the features provided in this class. Before accessing properties call the function mvIMPACT.acquire.Component.isValid. Right now only the mvBlueFOX-x00wx, mvBlueFOX-x02dx and mvBlueCOUGAR-x00wx as well as mvBlueCOUGAR-x02dx types will support the features defined by this class.

Instances of these class can't be constructed directly. Its parameters can be accessed via an instance of the class mvIMPACT.acquire.CameraSettingsBlueFOX or mvIMPACT.acquire.CameraSettingsBlueCOUGAR.

This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

HDRControl() [1/2]

HDRControl ( long cPtr, boolean cMemoryOwn )

protected

HDRControl() [2/2]

HDRControl

(

HDRControl

src

)

Copy constructor.

Creates a new object from an existing device object. Keep in mind that this new object will provide access to the very same hardware and therefore you might as well use the original reference. This constructor is only provided for internal reference counting to guarantee correct operation of the objects of this class under all platforms and languages.

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getHDREnable()

PropertyI getHDREnable

(

)

An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

getHDRKneePoint()

HDRKneePoint getHDRKneePoint

(

long

nr

)

Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.

Use the property mvIMPACT.acquire.HDRControl.getHDRKneePointCount() to find out how many knee points are available or to change the number of knee points.

Returns

A reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.

Parameters

nr	[in] The number of the knee point to be returned

getHDRKneePointCount()

PropertyI getHDRKneePointCount

(

)

An integer property to define the number of knee points to work with when mvIMPACT.acquire.HDRControl.getHDRMode() is set to mvIMPACT.acquire.TCameraHDRMode.cHDRmUser.

getHDRMode()

PropertyI getHDRMode

(

)

An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraHDRMode.

hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

isAvailable()

boolean isAvailable

(

)

This function should be called to check if this device offers HDR (High Dynamic Range) control parameters.

Returns

• true if the device offers the features defined by this object.
• false otherwise

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( HDRControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited