ImageRequestControl Class Reference

A helper class to control the way an image request will be processed. More...

Inheritance diagram for ImageRequestControl:

Public Member Functions
synchronized void	delete ()
PropertyI	getImageCount ()
	An integer property defining the number of images to capture with each request.
PropertyI	getMode ()
	The mode this object shall be operated in.
PropertyI	getRequestQueue ()
	An integer property defining to which request queue the image request will be sent.
PropertyI	getRequestToUse ()
	An integer property defining which request object shall be used for the next image request.
PropertyI	getResultQueue ()
	An integer property defining to which result queue the resulting image will be sent after the acquisition.
PropertyI	getSetting ()
	An integer property defining which setting will be used for the acquisition.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	ImageRequestControl (Device pDev)
	Constructs a new mvIMPACT.acquire.ImageRequestControl object.
	ImageRequestControl (Device pDev, String name)
	Constructs a new mvIMPACT.acquire.ImageRequestControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	ImageRequestControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (ImageRequestControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A helper class to control the way an image request will be processed.

Constructor & Destructor Documentation

ImageRequestControl() [1/3]

ImageRequestControl ( long cPtr, boolean cMemoryOwn )

protected

ImageRequestControl() [2/3]

ImageRequestControl	(	Device	pDev,
		String	name )

Constructs a new mvIMPACT.acquire.ImageRequestControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
name	[in] 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 mvIMPACT.acquire.FunctionInterface.getAvailableImageRequestControls, new image request controls can be created with the function mvIMPACT.acquire.FunctionInterface.createImageRequestControl

ImageRequestControl() [3/3]

ImageRequestControl

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.ImageRequestControl object.

Parameters

pDev

[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableImageRequestControls, new image request controls can be created with the function mvIMPACT.acquire.FunctionInterface.createImageRequestControl

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getImageCount()

PropertyI getImageCount

(

)

An integer property defining the number of images to capture with each request.

Note

This property will currently have no effect.

getMode()

PropertyI getMode

(

)

The mode this object shall be operated in.

Valid values for this property are defined by the enumeration mvIMPACT.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.

Device pDev = getDevicePointerFromSomewhere();
ImageRequestControl irc = new ImageRequestControl( pDev );
irc.getMode().write( TImageRequestControlMode.ircmTrial ); // set to prepare mode
FunctionInterface fi = new FunctionInterface( pDev );
fi.imageRequestSingle( irc ); // request dummy image
int reqNr = fi.imageRequestWaitFor( 500 );
// waitFor will return as fast as possible. No 'real' image will be taken
// but a request object that contains a dummy image with the format, dimensions
// and other information will be returned that is (apart from the pixel data)
// similar to any 'real' image that would be captured with the current settings

getRequestQueue()

PropertyI getRequestQueue

(

)

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

Since

2.47.0

getRequestToUse()

PropertyI getRequestToUse

(

)

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.

getResultQueue()

PropertyI getResultQueue

(

)

An integer property defining to which result queue the resulting image will be sent after the acquisition.

getSetting()

PropertyI getSetting

(

)

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

hObj()

int hObj ( )

inherited

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

ComponentCollection restoreDefault ( )

inherited

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( ImageRequestControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited