mvIMPACT Acquire SDK C++

Category for Test Control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 TestControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::TestControl object.
 

Public Attributes

Method testEventGenerate
 A method object. Generates a Test Event.
 
PropertyI64 testPayloadFormatMode
 An enumerated integer property. This feature allows setting a device in test mode and to output a specific payload format for validation of data streaming.
 
PropertyI64 testPendingAck
 An integer property. Tests the device's pending acknowledge feature.
 

Detailed Description

Category for Test Control features.

A category for Test Control features.

Constructor & Destructor Documentation

◆ TestControl()

TestControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::TestControl 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 Data Documentation

◆ testEventGenerate

Method testEventGenerate

A method object. Generates a Test Event.

Generates a Test Event.

◆ testPayloadFormatMode

PropertyI64 testPayloadFormatMode

An enumerated integer property. This feature allows setting a device in test mode and to output a specific payload format for validation of data streaming.

This feature allows setting a device in test mode and to output a specific payload format for validation of data streaming. This feature is intended solely for test purposes. The data can be real acquired data or any test pattern.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): The test mode is disabled. This feature has no effect and the device is streaming data normally according to its configuration. This option has to be the default after each boot of the device.
  • MultiPart (Display string: 'Multi Part'): The device streams data using multi-part payload format with at least one part in each payload. This option must be present if and only if the device supports the multi-part payload format.
  • GenDC (Display string: 'GenDC'): The device streams data using GenDC payload format with at least one component in each payload. This option must be present if the device supports the GenDC payload format.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ testPendingAck

PropertyI64 testPendingAck

An integer property. Tests the device's pending acknowledge feature.

Tests the device's pending acknowledge feature. When this feature is written, the device waits a time period corresponding to the value of TestPendingAck before acknowledging the write.