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
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
HDRKneePoint	getHDRKneePoint (int i)
	Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyIBoolean	HDREnable = new PropertyIBoolean()
	An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.
readonly PropertyI	HDRKneePointCount = new PropertyI()
	An integer property to define the number of knee points to work with when mv.impact.acquire.HDRControl.HDRMode is set to mv.impact.acquire.TCameraHDRMode.cHDRmUser.
readonly EnumPropertyI< TCameraHDRMode >	HDRMode = new EnumPropertyI<TCameraHDRMode>()
	An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.
readonly ReadOnlyCollection< HDRKneePoint >	kneePoints

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.
bool	isAvailable [get]
	This function should be called to check if this device offers auto control parameters.

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 mv.impact.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 mv.impact.acquire.CameraSettingsBlueFOX or mv.impact.acquire.CameraSettingsBlueCOUGAR.

This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

getHDRKneePoint()

HDRKneePoint getHDRKneePoint ( int i )

inline

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

Use the property mv.impact.acquire.HDRControl.HDRKneePointCount 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

[in]

i

The number of the knee point to be returned

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

HDREnable

readonly PropertyIBoolean HDREnable = new PropertyIBoolean()

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 mv.impact.acquire.TBoolean.

HDRKneePointCount

readonly PropertyI HDRKneePointCount = new PropertyI()

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

HDRMode

readonly EnumPropertyI<TCameraHDRMode> HDRMode = new EnumPropertyI<TCameraHDRMode>()

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 mv.impact.acquire.TCameraHDRMode.

kneePoints

readonly ReadOnlyCollection<HDRKneePoint> kneePoints

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

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

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

Returns

A unique identifier for the component referenced by this object.

isAvailable

bool isAvailable

get

This function should be called to check if this device offers auto control parameters.

Returns

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