mvIMPACT Acquire SDK C++
ImageRequestControl Class Reference

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

Inheritance diagram for ImageRequestControl:
ComponentCollection

Public Member Functions

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

Public Attributes

PropertyI imageCount
 An integer property defining the number of images to capture with each request. More...
 
PropertyIImageRequestControlMode mode
 The mode this object shall be operated in. More...
 
PropertyI requestToUse
 An integer property defining which request object shall be used for the next image request. More...
 
PropertyI resultQueue
 An integer property defining to which result queue the resulting image will be sent after the acquisition. More...
 
PropertyI setting
 An integer property defining which setting will be used for the acquisition. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImageRequestControl()

ImageRequestControl ( Device pDev,
const std::string &  name = "Base" 
)
inlineexplicit

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

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

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

◆ imageCount

PropertyI imageCount

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

Note
This property will currently have no effect.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mode

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( pDev );
irc.mode.write( ircmTrial ); // set to prepare mode
FunctionInterface fi( 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
ImageRequestControl(Device *pDev, const std::string &name="Base")
Constructs a new mvIMPACT::acquire::ImageRequestControl object.
Definition: mvIMPACT_acquire.h:10063
@ ircmTrial
In this mode no 'real' image will be captured, but the whole processing chain will be traversed once.
Definition: mvDriverBaseEnums.h:4286

◆ requestToUse

PropertyI requestToUse

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.

◆ resultQueue

PropertyI resultQueue

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

◆ setting

PropertyI setting

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.


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