Impact Acquire SDK Java

Category for Test Control features. More...

Public Member Functions

synchronized void delete ()
 
Method getTestEventGenerate ()
 A method object.
 
PropertyI64 getTestPayloadFormatMode ()
 An enumerated integer property.
 
PropertyI64 getTestPendingAck ()
 An integer property.
 
 TestControl (Device pDev)
 Constructs a new mvIMPACT.acquire.TestControl object.
 
 TestControl (Device pDev, String settingName)
 Constructs a new mvIMPACT.acquire.TestControl object.
 

Protected Member Functions

void finalize ()
 
 TestControl (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (TestControl obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Category for Test Control features.

A category for Test Control features.

Constructor & Destructor Documentation

◆ TestControl() [1/3]

TestControl ( long cPtr,
boolean cMemoryOwn )
protected

◆ TestControl() [2/3]

TestControl ( Device pDev,
String settingName )

Constructs a new mvIMPACT.acquire.TestControl object.

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

◆ TestControl() [3/3]

Constructs a new mvIMPACT.acquire.TestControl object.

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

◆ delete()

synchronized void delete ( )

◆ finalize()

void finalize ( )
protected

◆ getTestEventGenerate()

Method getTestEventGenerate ( )

A method object.

Generates a Test Event.

Generates a Test Event.

◆ getTestPayloadFormatMode()

PropertyI64 getTestPayloadFormatMode ( )

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ getTestPendingAck()

PropertyI64 getTestPendingAck ( )

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.

◆ swigRelease()

static long swigRelease ( TestControl obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protected