Impact Acquire SDK .NET
|
A helper class to control the way an image request will be processed. More...
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. | |
ImageRequestControl (Device device) | |
Constructs a new mv.impact.acquire.ImageRequestControl object. | |
ImageRequestControl (Device device, String name) | |
Constructs a new mv.impact.acquire.ImageRequestControl object. | |
void | restoreDefault () |
Restores the default for every component of this collection. | |
Public Attributes | |
readonly PropertyI | imageCount = new PropertyI() |
An integer property defining the number of images to capture with each request. | |
readonly EnumPropertyI< TImageRequestControlMode > | mode = new EnumPropertyI<TImageRequestControlMode>() |
The mode this object shall be operated in. | |
readonly PropertyI | requestQueue = new PropertyI() |
An integer property defining to which request queue the image request will be sent. | |
readonly PropertyI | requestToUse = new PropertyI() |
An integer property defining which request object shall be used for the next image request. | |
readonly PropertyI | resultQueue = new PropertyI() |
An integer property defining to which result queue the resulting image will be sent after the acquisition. | |
readonly PropertyI | setting = new PropertyI() |
An integer property defining which setting will be used for the acquisition. | |
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. | |
A helper class to control the way an image request will be processed.
|
inline |
Constructs a new mv.impact.acquire.ImageRequestControl object.
[in] | device | A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object. |
|
inline |
Constructs a new mv.impact.acquire.ImageRequestControl object.
[in] | device | A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object. |
[in] | name | The name of the driver internal image request control to access with this instance. A list of valid setting names can be obtained by a call to mv.impact.acquire.FunctionInterface.availableImageRequestControls, new image request controls can be created with the function mv.impact.acquire.FunctionInterface.createImageRequestControl |
|
inlineinherited |
Returns an enumerator of a certain type that iterates through the collection.
This interface will allow to e.g. write code like this:
See the framework's documentation about the System.Collections.IEnumerable interface for more information.
|
inlineinherited |
Returns an enumerator that iterates through the collection.
See the framework's documentation about the System.Collections.IEnumerable interface for more information.
|
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.
An integer property defining the number of images to capture with each request.
readonly EnumPropertyI<TImageRequestControlMode> mode = new EnumPropertyI<TImageRequestControlMode>() |
The mode this object shall be operated in.
Valid values for this property are defined by the enumeration mv.impact.acquire.TImageRequestControlMode.
This property can e.g. be used to prepare internal data structures without requesting a 'real' image from the hardware. This can be useful when the image dimensions must be known before the first image is captured.
Example
An integer property defining to which request queue the image request will be sent.
This property defines the stream channel requests associated with this request control instance will be sent to.
The maximum value for this feature corresponds to the number of independent stream channels offered by the device. Only devices operated in interface layout mv.impact.acquire.TDeviceInterfaceLayout.dilGenICam may offer more than one stream channel. Therefore the default value and the default maximum and minimum value will be 0 for most devices.
An integer property defining which request object shall be used for the next image request.
This is an advanced feature that should only be used if needed. A value smaller than 0 will result in an automatic mode. This is the default behaviour and the driver will decide which buffer to use next then.
A request can only be sent to the driver once. Until this request is returned to the user it can't be sent again thus this property must be changed for each request if multiple requests shall be sent to the capture queue.
An integer property defining to which result queue the resulting image will be sent after the acquisition.
An integer property defining which setting will be used for the acquisition.
This property defines a translation dictionary. It maps the name of the setting (the parameter passed to the function mv.impact.acquire.FunctionInterface.createSetting) to the actual underlying handle of the request. Therefore either the name or the handle of the setting can be used to set this property to the desired value.
|
getinherited |
Returns an enumerator that iterates through the collection.
This interface will allow to e.g. write code like this:
See the framework's documentation about the System.Collections.IEnumerable interface for more information.
|
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:
See the framework's documentation about the System.Collections.IEnumerable interface for more information.
|
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.