HDRControl Class Reference

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

#include <mvIMPACT_acquire.h>

Inheritance diagram for HDRControl:

Public Member Functions
HDRKneePoint &	getHDRKneePoint (unsigned int nr) const
	Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.
	HDRControl (const HDRControl &src)
	Copy constructor.
HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.
bool	isAvailable (void) const
	This function should be called to check if this device offers HDR (High Dynamic Range) control parameters.
HDRControl &	operator= (const HDRControl &rhs)
	Allows assignments of mvIMPACT::acquire::HDRControl objects.
const ComponentCollection &	restoreDefault (void) const
	Restores the default for every component of this collection.
	~HDRControl ()

Public Attributes
PropertyIBoolean	HDREnable
	An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.
PropertyI	HDRKneePointCount
	An integer property to define the number of knee points to work with when mvIMPACT::acquire::HDRControl::HDRMode is set to mvIMPACT::acquire::cHDRmUser.
PropertyICameraHDRMode	HDRMode
	An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.

Protected Attributes
HOBJ	m_hRoot

Friends
class	CameraSettingsBlueCOUGAR
class	CameraSettingsBlueFOX

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::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

HDRControl()

HDRControl ( const HDRControl & src )

inlineexplicit

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.

~HDRControl()

~HDRControl ( )

inline

Member Function Documentation

getHDRKneePoint()

HDRKneePoint & getHDRKneePoint ( unsigned int nr ) const

inline

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::HDRKneePointCount to find out how many knee points are available or to change the number of knee points.

If nr is invalid(too large) an STL out_of_range exception will be thrown.

Returns

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

Parameters

[in]

nr

The number of the knee point to be returned

hObj()

HOBJ hObj ( void ) const

inlineinherited

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()

bool isAvailable ( void ) const

inline

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

operator=()

HDRControl & operator= ( const HDRControl & rhs )

inline

Allows assignments of mvIMPACT::acquire::HDRControl objects.

restoreDefault()

const ComponentCollection & restoreDefault ( void ) const

inlineinherited

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.

Friends And Related Symbol Documentation

CameraSettingsBlueCOUGAR

friend class CameraSettingsBlueCOUGAR

friend

CameraSettingsBlueFOX

friend class CameraSettingsBlueFOX

friend

Member Data Documentation

HDREnable

PropertyIBoolean HDREnable

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.

HDRKneePointCount

PropertyI HDRKneePointCount

An integer property to define the number of knee points to work with when mvIMPACT::acquire::HDRControl::HDRMode is set to mvIMPACT::acquire::cHDRmUser.

HDRMode

PropertyICameraHDRMode HDRMode

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.

m_hRoot

HOBJ m_hRoot

protectedinherited