Impact Acquire SDK C++
Public Member Functions | Public Attributes | Protected Attributes | List of all members
RequestInfoConfiguration Class Reference
Common

Properties to configure which information shall be attached to the resulting images. More...

#include <mvIMPACT_acquire.h>

Inheritance diagram for RequestInfoConfiguration:
[legend]

Public Member Functions

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

Public Attributes

PropertyIBoolean exposeStart_us
 An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean exposeTime_us
 An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean frameID
 An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean frameNr
 An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean gain_dB
 An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean imageAverage
 An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean IOStatesAtExposureStart
 An enumerated integer property which can be used to configure whether the I/O states at exposure start information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean lineCounter
 An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean lineStatusAll
 An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean missingData_pc
 An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean settingUsed
 An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean timeStamp_us
 An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean transferDelay_us
 An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean triggerCounterAcquisitionStart
 An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean triggerCounterFrameStart
 An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean userData
 An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 
PropertyIBoolean videoChannel
 An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mvIMPACT::acquire::Request objects.
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Properties to configure which information shall be attached to the resulting images.

This class provides properties allowing the user to define which additional information shall be attached to the resulting images. For example some devices can transmit the state of the digital I/Os at the time the exposure of an image has been started. Some information will always be attached to the resulting images other information will only be available if it has been explicitly enabled before.

EXAMPLE:

Enable the transmission of the LineStatusAll information in device interface layout mvIMPACT::acquire::dilDeviceSpecific:

//-----------------------------------------------------------------------------
void fn( Device* pDev )
//-----------------------------------------------------------------------------
{
RequestInfoConfiguration ric( pDev );
if( !ric.lineStatusAll.isValid() )
{
// feature not supported
return;
}
ric.lineStatusAll.write( bTrue );
Request* pRequest = captureAnImage( pDev );
printf( "%s: 0x%08x\n", pRequest->chunkLineStatusAll.name().c_str(), static_cast< int >( pRequest->chunkLineStatusAll.read() ) );
}
mvIMPACT::acquire::ComponentAccess::name
std::string name(void) const
Returns the name of the component referenced by this object.
Definition mvIMPACT_acquire.h:1206
mvIMPACT::acquire::Device
This class and its functions represent an actual device detected by this interface in the current sys...
Definition mvIMPACT_acquire.h:6118
mvIMPACT::acquire::EnumPropertyI64::read
ZYX read(int index=0) const
Reads a value from a property.
Definition mvIMPACT_acquire.h:4907
mvIMPACT::acquire::RequestInfoConfiguration
Properties to configure which information shall be attached to the resulting images.
Definition mvIMPACT_acquire.h:12565
mvIMPACT::acquire::Request
Contains information about a captured buffer.
Definition mvIMPACT_acquire.h:8628
mvIMPACT::acquire::Request::chunkLineStatusAll
PropertyI64 chunkLineStatusAll
A 64 bit integer property (read-only) containing the status of all I/O lines at the time of the inter...
Definition mvIMPACT_acquire.h:10084
mvIMPACT::acquire::bTrue
@ bTrue
On, true or logical high.
Definition mvDriverBaseEnums.h:591

E.g. for the mvBlueCOUGAR-X/XD series possible LineStatusAll values are

  • 0x11, Out0 and In0 on (Out0 needs to be connected with In0 for this to work)
  • 0x33, Out0, Out1, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
  • 0x37, Out0, Out1, Out2, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
  • 0x3f, Out0, Out1, Out2, Out3, In0 and In1 on (Out0 and Out1 need to be connected with in0 and in1 for this to work)
Since
2.10.0

Constructor & Destructor Documentation

◆ RequestInfoConfiguration()

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

brief Constructs a new mvIMPACT::acquire::RequestInfoConfiguration 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

◆ exposeStart_us

PropertyIBoolean exposeStart_us

An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ exposeTime_us

PropertyIBoolean exposeTime_us

An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ frameID

PropertyIBoolean frameID

An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ frameNr

PropertyIBoolean frameNr

An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ gain_dB

PropertyIBoolean gain_dB

An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ imageAverage

PropertyIBoolean imageAverage

An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature currently is only available for mvBlueFOX devices

◆ IOStatesAtExposureStart

PropertyIBoolean IOStatesAtExposureStart

An enumerated integer property which can be used to configure whether the I/O states at exposure start information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
This feature currently is only available for mvBlueFOX-MLC devices.

◆ lineCounter

PropertyIBoolean lineCounter

An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature currently is only available for mvTITAN-CL, mvGAMMA-CL and mvTITAN-DIG devices

◆ lineStatusAll

PropertyIBoolean lineStatusAll

An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature may be available for GenICam compliant devices

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ missingData_pc

PropertyIBoolean missingData_pc

An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ settingUsed

PropertyIBoolean settingUsed

An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ timeStamp_us

PropertyIBoolean timeStamp_us

An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ transferDelay_us

PropertyIBoolean transferDelay_us

An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature currently is only available for mvBlueFOX devices

◆ triggerCounterAcquisitionStart

PropertyIBoolean triggerCounterAcquisitionStart

An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature currently is only available for mvHYPERION devices

◆ triggerCounterFrameStart

PropertyIBoolean triggerCounterFrameStart

An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
  • This feature currently is only available for mvHYPERION devices

◆ userData

PropertyIBoolean userData

An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Note
This feature currently is only available for mvVirtual devices.

◆ videoChannel

PropertyIBoolean videoChannel

An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mvIMPACT::acquire::Request objects.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.