ActionControl Class Reference

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

Public Member Functions
	ActionControl (Device pDev)
	Constructs a new mvIMPACT.acquire.ActionControl object.
	ActionControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.ActionControl object.
synchronized void	delete ()
PropertyI64	getActionDeviceKey ()
	An integer property.
PropertyI64	getActionGroupKey ()
	An integer property.
PropertyI64	getActionGroupMask ()
	An integer property.
PropertyI64	getActionQueueSize ()
	An integer property.
PropertyI64	getActionSelector ()
	An integer property.
PropertyI64	getActionUnconditionalMode ()
	An enumerated integer property.

Protected Member Functions
	ActionControl (long cPtr, boolean cMemoryOwn)
void	finalize ()

Static Protected Member Functions
static long	swigRelease (ActionControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category that contains the Action control features.

A category that contains the Action control features.

Constructor & Destructor Documentation

ActionControl() [1/3]

ActionControl ( long cPtr, boolean cMemoryOwn )

protected

ActionControl() [2/3]

ActionControl	(	Device	pDev,
		String	settingName )

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

ActionControl() [3/3]

ActionControl

(

Device

pDev

)

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. 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

getActionDeviceKey()

PropertyI64 getActionDeviceKey

(

)

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.

getActionGroupKey()

PropertyI64 getActionGroupKey

(

)

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.

getActionGroupMask()

PropertyI64 getActionGroupMask

(

)

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.

getActionQueueSize()

PropertyI64 getActionQueueSize

(

)

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.

getActionSelector()

PropertyI64 getActionSelector

(

)

An integer property.

Selects to which Action Signal further Action settings apply.

Selects to which Action Signal further Action settings apply.

getActionUnconditionalMode()

PropertyI64 getActionUnconditionalMode

(

)

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.

swigRelease()

static long swigRelease ( ActionControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected