HDRKneePoint Class Reference

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

Inheritance diagram for HDRKneePoint:

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.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyI	HDRControlVoltage_mV = new PropertyI()
	An enumerated integer property that can be used to define the control voltage in mV for this knee point.
readonly PropertyI	HDRExposure_ppm = new PropertyI()
	An enumerated integer property that can be used to define the exposure time in ppm of the overall exposure time for this knee point.

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.

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 mv.impact.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 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 framework's 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 framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

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

HDRControlVoltage_mV

readonly PropertyI HDRControlVoltage_mV = new PropertyI()

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

HDRExposure_ppm

readonly PropertyI HDRExposure_ppm = new PropertyI()

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

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 framework's 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 framework's 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.