A base class for essential device related settings. More...

#include <mvIMPACT_acquire.h>

Inheritance diagram for BasicDeviceSettings:

Public Member Functions
	BasicDeviceSettings (Device *pDev, const std::string &settingName="Base")
	brief Constructs a new mvIMPACT::acquire::BasicDeviceSettings object.

HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.

const ComponentCollection &	restoreDefault (void) const
	Restores the default for every component of this collection.

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

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

Protected Attributes
HOBJ	m_hRoot

Detailed Description

A base class for essential device related settings.

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

Since: 1.12.58

Examples: Callback.cpp.

Constructor & Destructor Documentation

◆ BasicDeviceSettings()

BasicDeviceSettings	(	Device *	pDev,
		const std::string &	settingName = "Base" )

inlineexplicit

brief Constructs a new mvIMPACT::acquire::BasicDeviceSettings object.

Parameters

[in]	pDev	A pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]	settingName	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

Member Function Documentation

◆ hObj()

HOBJ hObj ( void ) const

inlineinherited

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

const ComponentCollection & restoreDefault ( void ) const

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.

Returns: A const reference to the component.

Member Data Documentation

◆ basedOn

PropertyS basedOn

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

Since: 1.12.67

◆ imageRequestTimeout_ms

PropertyI imageRequestTimeout_ms

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.

◆ m_hRoot

HOBJ m_hRoot

protectedinherited

Public Member Functions

Public Attributes

Protected Attributes