ActionControl Class Reference

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

Inheritance diagram for ActionControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.ActionControl object.

Properties
	actionDeviceKey = property(lib_mvIMPACT_acquire.ActionControl_actionDeviceKey_get, doc=)
	An integer property.
	actionGroupKey = property(lib_mvIMPACT_acquire.ActionControl_actionGroupKey_get, doc=)
	An integer property.
	actionGroupMask = property(lib_mvIMPACT_acquire.ActionControl_actionGroupMask_get, doc=)
	An integer property.
	actionQueueSize = property(lib_mvIMPACT_acquire.ActionControl_actionQueueSize_get, doc=)
	An integer property.
	actionSelector = property(lib_mvIMPACT_acquire.ActionControl_actionSelector_get, doc=)
	An integer property.
	actionUnconditionalMode = property(lib_mvIMPACT_acquire.ActionControl_actionUnconditionalMode_get, doc=)
	An enumerated integer property.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Category that contains the Action control features.

A category that contains the Action control features.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

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

Property Documentation

actionDeviceKey

actionDeviceKey = property(lib_mvIMPACT_acquire.ActionControl_actionDeviceKey_get, doc=)

static

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

actionGroupKey = property(lib_mvIMPACT_acquire.ActionControl_actionGroupKey_get, doc=)

static

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

actionGroupMask = property(lib_mvIMPACT_acquire.ActionControl_actionGroupMask_get, doc=)

static

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

actionQueueSize = property(lib_mvIMPACT_acquire.ActionControl_actionQueueSize_get, doc=)

static

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

actionSelector = property(lib_mvIMPACT_acquire.ActionControl_actionSelector_get, doc=)

static

An integer property.

Selects to which Action Signal further Action settings apply.

Selects to which Action Signal further Action settings apply.

actionUnconditionalMode

actionUnconditionalMode = property(lib_mvIMPACT_acquire.ActionControl_actionUnconditionalMode_get, doc=)

static

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

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static