mvIMPACT Acquire SDK C++
HDRKneePoint Class Reference

A class to configure a HDR (High Dynamic Range) knee point (Device specific interface layout only). More...

Inheritance diagram for HDRKneePoint:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI HDRControlVoltage_mV
 An enumerated integer property that can be used to define the control voltage in mV for this knee point. More...
 
PropertyI HDRExposure_ppm
 An enumerated integer property that can be used to define the exposure time in ppm of the overall exposure time for this knee point. More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class HDRControl
 

Detailed Description

A class to configure a HDR (High Dynamic Range) knee point (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 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.

Member Function Documentation

◆ 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.

◆ 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 Function Documentation

◆ HDRControl

friend class HDRControl
friend

Member Data Documentation

◆ HDRControlVoltage_mV

PropertyI HDRControlVoltage_mV

An enumerated integer property that can be used to define the control voltage in mV for this knee point.

◆ HDRExposure_ppm

PropertyI HDRExposure_ppm

An enumerated integer property that can be used to define the exposure time in ppm of the overall exposure time for this knee point.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

The documentation for this class was generated from the following file: