mvIMPACT Acquire SDK C++

Category that contains the Action control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

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

Public Attributes

PropertyI64 actionDeviceKey
 An integer property. Provides the device key that allows the device to check the validity of action commands.
 
PropertyI64 actionGroupKey
 An integer property. Provides the key that the device will use to validate the action on reception of the action protocol message.
 
PropertyI64 actionGroupMask
 An integer property. Provides the mask that the device will use to validate the action on reception of the action protocol message.
 
PropertyI64 actionQueueSize
 An integer property. Indicates the size of the scheduled action commands queue.
 
PropertyI64 actionSelector
 An integer property. Selects to which Action Signal further Action settings apply.
 
PropertyI64 actionUnconditionalMode
 An enumerated integer property. Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.
 

Detailed Description

Category that contains the Action control features.

A category that contains the Action control features.

Examples
GigEVisionActionFeatures.cpp.

Constructor & Destructor Documentation

◆ ActionControl()

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

Constructs a new mvIMPACT::acquire::GenICam::ActionControl 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

◆ actionDeviceKey

PropertyI64 actionDeviceKey

An integer property. Provides the device key that allows the device to check the validity of action commands.

Provides the device key that allows the device to check the validity of action commands. The device internal assertion of an action signal is only authorized if the ActionDeviceKey and the action device key value in the protocol message are equal.

◆ actionGroupKey

PropertyI64 actionGroupKey

An integer property. Provides the key that the device will use to validate the action on reception of the action protocol message.

Provides the key that the device will use to validate the action on reception of the action protocol message.

◆ actionGroupMask

PropertyI64 actionGroupMask

An integer property. Provides the mask that the device will use to validate the action on reception of the action protocol message.

Provides the mask that the device will use to validate the action on reception of the action protocol message.

◆ actionQueueSize

PropertyI64 actionQueueSize

An integer property. Indicates the size of the scheduled action commands queue.

Indicates the size of the scheduled action commands queue. This number represents the maximum number of scheduled action commands that can be pending at a given point in time.

◆ actionSelector

PropertyI64 actionSelector

An integer property. Selects to which Action Signal further Action settings apply.

Selects to which Action Signal further Action settings apply.

◆ actionUnconditionalMode

PropertyI64 actionUnconditionalMode

An enumerated integer property. Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.

Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): Unconditional mode is disabled.
  • On (Display string: 'On'): Unconditional mode is enabled.
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.