mvIMPACT Acquire SDK C++
BasicDeviceSettingsWithAOI Class Reference

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

Inheritance diagram for BasicDeviceSettingsWithAOI:
BasicDeviceSettings ComponentCollection CameraSettingsBase CameraSettingsV4L2Device CameraSettingsBlueDevice CameraSettingsFrameGrabber CameraSettingsVirtualDevice CameraSettingsBlueCOUGAR CameraSettingsBlueFOX

Public Member Functions

 BasicDeviceSettingsWithAOI (Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::BasicDeviceSettingsWithAOI object. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI aoiHeight
 An integer property defining the number of lines to capture. More...
 
PropertyI aoiStartX
 An integer property defining the X-offset for each capture line. More...
 
PropertyI aoiStartY
 An integer property defining the Y-offset. More...
 
PropertyI aoiWidth
 An integer property defining the number of pixels to capture per line. More...
 
PropertyS basedOn
 A string property (read-only) containing the name of the setting this setting is based on. More...
 
PropertyI imageRequestTimeout_ms
 An integer property defining the maximum time to wait for an image in ms. More...
 

Protected Attributes

HOBJ m_hRoot
 

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::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ BasicDeviceSettingsWithAOI()

BasicDeviceSettingsWithAOI ( Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::BasicDeviceSettingsWithAOI object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

◆ aoiHeight

PropertyI aoiHeight

An integer property defining the number of lines to capture.

◆ aoiStartX

PropertyI aoiStartX

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.

◆ aoiStartY

PropertyI aoiStartY

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.

◆ aoiWidth

PropertyI aoiWidth

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

◆ basedOn

PropertyS basedOn
inherited

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
inherited

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

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

The documentation for this class was generated from the following file: