Impact Acquire SDK .NET

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

Public Member Functions

 ActionControl (mv.impact.acquire.Device device)
 Constructs a new mv.impact.acquire.GenICam.ActionControl object.
 
 ActionControl (mv.impact.acquire.Device device, System.String settingName)
 Constructs a new mv.impact.acquire.GenICam.ActionControl object.
 

Public Attributes

readonly mv.impact.acquire.PropertyI64 actionDeviceKey = new mv.impact.acquire.PropertyI64()
 An integer property. Provides the device key that allows the device to check the validity of action commands.
 
readonly mv.impact.acquire.PropertyI64 actionGroupKey = new mv.impact.acquire.PropertyI64()
 An integer property. Provides the key that the device will use to validate the action on reception of the action protocol message.
 
readonly mv.impact.acquire.PropertyI64 actionGroupMask = new mv.impact.acquire.PropertyI64()
 An integer property. Provides the mask that the device will use to validate the action on reception of the action protocol message.
 
readonly mv.impact.acquire.PropertyI64 actionQueueSize = new mv.impact.acquire.PropertyI64()
 An integer property. Indicates the size of the scheduled action commands queue.
 
readonly mv.impact.acquire.PropertyI64 actionSelector = new mv.impact.acquire.PropertyI64()
 An integer property. Selects to which Action Signal further Action settings apply.
 
readonly mv.impact.acquire.PropertyI64 actionUnconditionalMode = new mv.impact.acquire.PropertyI64()
 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.

Constructor & Destructor Documentation

◆ ActionControl() [1/2]

Constructs a new mv.impact.acquire.GenICam.ActionControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ ActionControl() [2/2]

ActionControl ( mv::impact::acquire::Device device,
System::String settingName )
inline

Constructs a new mv.impact.acquire.GenICam.ActionControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Data Documentation

◆ 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

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

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

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

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

Selects to which Action Signal further Action settings apply.

◆ 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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.