BasicDeviceSettingsWithAOI Class Reference

A base class for camera related settings(Device specific interface layout only). More...

Inheritance diagram for BasicDeviceSettingsWithAOI:

Public Member Functions
	BasicDeviceSettingsWithAOI (Device pDev)
	Constructs a new mvIMPACT.acquire.BasicDeviceSettingsWithAOI object.
	BasicDeviceSettingsWithAOI (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.BasicDeviceSettingsWithAOI object.
synchronized void	delete ()
PropertyI	getAoiHeight ()
	An integer property defining the number of lines to capture.
PropertyI	getAoiStartX ()
	An integer property defining the X-offset for each capture line.
PropertyI	getAoiStartY ()
	An integer property defining the Y-offset.
PropertyI	getAoiWidth ()
	An integer property defining the number of pixels to capture per line.
PropertyS	getBasedOn ()
	A string property (read-only) containing the name of the setting this setting is based on.
PropertyI	getImageRequestTimeout_ms ()
	An integer property defining the maximum time to wait for an image in ms.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

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

Static Protected Member Functions
static long	swigRelease (BasicDeviceSettings obj)
static long	swigRelease (BasicDeviceSettingsWithAOI obj)
static long	swigRelease (ComponentCollection obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A base class for camera related settings(Device specific interface layout only).

This class acts as a base class for camera related settings. It only contains settings that are available for every device!

Note

This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

BasicDeviceSettingsWithAOI() [1/3]

BasicDeviceSettingsWithAOI ( long cPtr, boolean cMemoryOwn )

protected

BasicDeviceSettingsWithAOI() [2/3]

BasicDeviceSettingsWithAOI	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.BasicDeviceSettingsWithAOI object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

BasicDeviceSettingsWithAOI() [3/3]

BasicDeviceSettingsWithAOI

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.BasicDeviceSettingsWithAOI object.

Parameters

pDev

[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from BasicDeviceSettings.

Reimplemented in CameraSettingsBase, CameraSettingsBlueCOUGAR, CameraSettingsBlueDevice, CameraSettingsBlueFOX, CameraSettingsFrameGrabber, CameraSettingsV4L2Device, and CameraSettingsVirtualDevice.

finalize()

void finalize ( )

protected

Reimplemented from BasicDeviceSettings.

Reimplemented in CameraSettingsBase, CameraSettingsBlueCOUGAR, CameraSettingsBlueDevice, CameraSettingsBlueFOX, CameraSettingsFrameGrabber, CameraSettingsV4L2Device, and CameraSettingsVirtualDevice.

getAoiHeight()

PropertyI getAoiHeight

(

)

An integer property defining the number of lines to capture.

getAoiStartX()

PropertyI getAoiStartX

(

)

An integer property defining the X-offset for each capture line.

Example: When setting this property to 5 the first pixel in each line of the resulting image will be pixel number 5 of each line transmitted by the camera.

getAoiStartY()

PropertyI getAoiStartY

(

)

An integer property defining the Y-offset.

Example: When setting this property to 5 the first line of the resulting image will be line number 5 of the image transmitted by the camera.

getAoiWidth()

PropertyI getAoiWidth

(

)

An integer property defining the number of pixels to capture per line.

getBasedOn()

PropertyS getBasedOn ( )

inherited

A string property (read-only) containing the name of the setting this setting is based on.

Since

1.12.67

getImageRequestTimeout_ms()

PropertyI getImageRequestTimeout_ms ( )

inherited

An integer property defining the maximum time to wait for an image in ms.

Attention

Since Impact Acquire 2.32.0 the default value for this property has been changed! See Calling 'imageRequestWaitFor' Never Returns / An Application No Longer Terminates After Upgrading To Impact Acquire 2.32.0 Or Greater for details.

When this property is set to 0 the timeout never elapses. If the timeout this property defines elapses the currently processed request will be returned to the user even if no data has been captured so far. The result structure of the request object should be examined in that case. Also this should be considered as an error from the users point of view in which case he should clean up the acquisition queue by calling mvIMPACT.acquire.FunctionInterface.imageRequestReset. Afterwards the capture loop can be restarted.

Note

It is crucial to understand that this is a timeout PER REQUEST! The timespan taken into account for the measurement starts when the driver begins to capture data into this particular buffer! So when queuing 4 buffers with a timeout of 3000 ms each and no data being transmitted by the device for any reason will cause the last buffer to time out 3000*4 = 12000 ms AFTER the buffer has been queued and the acquisition has been started as the driver will wait for up to 3 seconds for each buffer that is being processed. When the device sends data this timeout does not affect the runtime behaviour at all. No additional delay is introduced by it when everything runs as planned.

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/3]

static long swigRelease ( BasicDeviceSettings obj )

staticprotectedinherited

swigRelease() [2/3]

static long swigRelease ( BasicDeviceSettingsWithAOI obj )

staticprotected

swigRelease() [3/3]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited