Category that contains the quadrature Encoder Control features. More...

Public Member Functions
synchronized void	delete ()

	EncoderControl (Device pDev)
	Constructs a new mvIMPACT.acquire.EncoderControl object.

	EncoderControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.EncoderControl object.

PropertyI64	getEncoderDivider ()
	An integer property.

PropertyI64	getEncoderMode ()
	An enumerated integer property.

PropertyI64	getEncoderOutputMode ()
	An enumerated integer property.

Method	getEncoderReset ()
	A method object.

PropertyI64	getEncoderResetActivation ()
	An enumerated integer property.

PropertyI64	getEncoderResetSource ()
	An enumerated integer property.

PropertyF	getEncoderResolution ()
	A floating point property.

PropertyI64	getEncoderSelector ()
	An enumerated integer property.

PropertyI64	getEncoderSourceA ()
	An enumerated integer property.

PropertyI64	getEncoderSourceB ()
	An enumerated integer property.

PropertyI64	getEncoderStatus ()
	An enumerated integer property.

PropertyF	getEncoderTimeout ()
	A floating point property.

PropertyI64	getEncoderValue ()
	An integer property.

PropertyI64	getEncoderValueAtReset ()
	An integer property.

Protected Member Functions
	EncoderControl (long cPtr, boolean cMemoryOwn)

void	finalize ()

Static Protected Member Functions
static long	swigRelease (EncoderControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category that contains the quadrature Encoder Control features.

A category that contains the quadrature Encoder Control features.

Constructor & Destructor Documentation

◆ EncoderControl() [1/3]

EncoderControl	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ EncoderControl() [2/3]

EncoderControl	(	Device	pDev,
		String	settingName )

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

◆ EncoderControl() [3/3]

EncoderControl ( Device pDev )

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

◆ getEncoderDivider()

PropertyI64 getEncoderDivider ( )

An integer property.

Sets how many Encoder increments/decrements are needed to generate an Encoder output pulse signal.

◆ getEncoderMode()

PropertyI64 getEncoderMode ( )

An enumerated integer property.

Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering.

The following string values might be valid for this feature:

FourPhase (Display string: 'Four Phase'): The counter increments or decrements 1 for every full quadrature cycle with jitter filtering.
HighResolution (Display string: 'High Resolution'): The counter increments or decrements every quadrature phase for high resolution counting, but without jitter filtering.

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.

◆ getEncoderOutputMode()

PropertyI64 getEncoderOutputMode ( )

An enumerated integer property.

Selects the conditions for the Encoder interface to generate a valid Encoder output signal.

The following string values might be valid for this feature:

Off (Display string: 'Off'): No output pulse are generated.
PositionUp (Display string: 'Position Up'): Output pulses are generated at all new positions in the positive direction. If the encoder reverses no output pulse are generated until it has again passed the position where the reversal started.
PositionDown (Display string: 'Position Down'): Output pulses are generated at all new positions in the negative direction. If the encoder reverses no output pulse are generated until it has again passed the position where the reversal started.
DirectionUp (Display string: 'Direction Up'): Output pulses are generated at all position increments in the positive direction while ignoring negative direction motion.
DirectionDown (Display string: 'Direction Down'): Output pulses are generated at all position increments in the negative direction while ignoring positive direction motion.
Motion (Display string: 'Motion'): Output pulses are generated at all motion increments in both directions.

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.

The following figure explains the different encoderOutputModes

encoderOutputModes

◆ getEncoderReset()

Method getEncoderReset ( )

A method object.

Does a software reset of the selected Encoder and starts it.

Does a software reset of the selected Encoder and starts it. The Encoder starts counting events immediately after the reset. EncoderReset can be used to reset the Encoder independently from the EncoderResetSource.

◆ getEncoderResetActivation()

PropertyI64 getEncoderResetActivation ( )

An enumerated integer property.

Selects the Activation mode of the Encoder Reset Source signal.

The following string values might be valid for this feature:

RisingEdge (Display string: 'Rising Edge'): Resets the Encoder on the Rising Edge of the signal.
FallingEdge (Display string: 'Falling Edge'): Resets the Encoder on the Falling Edge of the signal.
AnyEdge (Display string: 'Any Edge'): Resets the Encoder on the Falling or rising Edge of the selected signal.
LevelHigh (Display string: 'Level High'): Resets the Encoder as long as the selected signal level is High.
LevelLow (Display string: 'Level Low'): Resets the Encoder as long as the selected signal level is Low.

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.

◆ getEncoderResetSource()

PropertyI64 getEncoderResetSource ( )

An enumerated integer property.

Selects the signals that will be the source to reset the Encoder.

The following string values might be valid for this feature:

AcquisitionEnd (Display string: 'Acquisition End'): Resets with the reception of the Acquisition End.
AcquisitionStart (Display string: 'Acquisition Start'): Resets with the reception of the Acquisition Start.
AcquisitionTrigger (Display string: 'Acquisition Trigger'): Resets with the reception of the Acquisition Trigger.
AcquisitionTriggerMissed (Display string: 'Acquisition Trigger Missed'): Resets with the reception of a missed Acquisition Trigger.
Action0 (Display string: 'Action 0'): Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action1 (Display string: 'Action 1'): Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Action2 (Display string: 'Action 2'): Resets on assertions of the chosen action signal (Broadcasted signal on the transport layer).
Counter0End (Display string: 'Counter 0 End'): Resets with the reception of the Counter End.
Counter0Start (Display string: 'Counter 0 Start'): Resets with the reception of the Counter Start.
Counter1End (Display string: 'Counter 1 End'): Resets with the reception of the Counter End.
Counter1Start (Display string: 'Counter 1 Start'): Resets with the reception of the Counter Start.
Counter2End (Display string: 'Counter 2 End'): Resets with the reception of the Counter End.
Counter2Start (Display string: 'Counter 2 Start'): Resets with the reception of the Counter Start.
ExposureEnd (Display string: 'Exposure End'): Resets with the reception of the Exposure End.
ExposureStart (Display string: 'Exposure Start'): Resets with the reception of the Exposure Start.
FrameEnd (Display string: 'Frame End'): Resets with the reception of the Frame End.
FrameStart (Display string: 'Frame Start'): Resets with the reception of the Frame Start.
FrameTrigger (Display string: 'Frame Trigger'): Resets with the reception of the Frame Start Trigger.
FrameTriggerMissed (Display string: 'Frame Trigger Missed'): Resets with the reception of a missed Frame Trigger.
Line0 (Display string: 'Line 0'): Resets by the chosen I/O Line.
Line1 (Display string: 'Line 1'): Resets by the chosen I/O Line.
Line2 (Display string: 'Line 2'): Resets by the chosen I/O Line.
LinkTrigger0 (Display string: 'Link Trigger 0'): Resets on the reception of the chosen Link Trigger (received from the transport layer).
LinkTrigger1 (Display string: 'Link Trigger 1'): Resets on the reception of the chosen Link Trigger (received from the transport layer).
LinkTrigger2 (Display string: 'Link Trigger 2'): Resets on the reception of the chosen Link Trigger (received from the transport layer).
LogicBlock0 (Display string: 'Logic Block 0'): Reset by the choosen Logic Block signal.
LogicBlock1 (Display string: 'Logic Block 1'): Reset by the choosen Logic Block signal.
LogicBlock2 (Display string: 'Logic Block 2'): Reset by the choosen Logic Block signal.
Off (Display string: 'Off'): Disable the Encoder Reset trigger.
SoftwareSignal0 (Display string: 'Software Signal 0'): Resets on the reception of the Software Signal.
SoftwareSignal1 (Display string: 'Software Signal 1'): Resets on the reception of the Software Signal.
SoftwareSignal2 (Display string: 'Software Signal 2'): Resets on the reception of the Software Signal.
Timer0End (Display string: 'Timer 0 End'): Resets with the reception of the Timer End.
Timer0Start (Display string: 'Timer 0 Start'): Resets with the reception of the Timer Start.
Timer1End (Display string: 'Timer 1 End'): Resets with the reception of the Timer End.
Timer1Start (Display string: 'Timer 1 Start'): Resets with the reception of the Timer Start.
Timer2End (Display string: 'Timer 2 End'): Resets with the reception of the Timer End.
Timer2Start (Display string: 'Timer 2 Start'): Resets with the reception of the Timer Start.
UserOutput0 (Display string: 'User Output 0'): Resets by the chosen User Output bit.
UserOutput1 (Display string: 'User Output 1'): Resets by the chosen User Output bit.
UserOutput2 (Display string: 'User Output 2'): Resets by the chosen User Output bit.

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.

◆ getEncoderResolution()

PropertyF getEncoderResolution ( )

A floating point property.

Defines the resolution of one encoder step.

◆ getEncoderSelector()

PropertyI64 getEncoderSelector ( )

An enumerated integer property.

Selects which Encoder to configure.

The following string values might be valid for this feature:

Encoder0 (Display string: 'Encoder 0'): Selects Encoder 0.
Encoder1 (Display string: 'Encoder 1'): Selects Encoder 1.
Encoder2 (Display string: 'Encoder 2'): Selects Encoder 2.

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.

◆ getEncoderSourceA()

PropertyI64 getEncoderSourceA ( )

An enumerated integer property.

Selects the signal which will be the source of the A input of the Encoder.

The following string values might be valid for this feature:

Line0 (Display string: 'Line 0'): Encoder Forward input is taken from the chosen I/O Line.
Line1 (Display string: 'Line 1'): Encoder Forward input is taken from the chosen I/O Line.
Line2 (Display string: 'Line 2'): Encoder Forward input is taken from the chosen I/O Line.
Off (Display string: 'Off'): Counter is stopped.

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.

◆ getEncoderSourceB()

PropertyI64 getEncoderSourceB ( )

An enumerated integer property.

Selects the signal which will be the source of the B input of the Encoder.

The following string values might be valid for this feature:

Line0 (Display string: 'Line 0'): Encoder Reverse input is taken from the chosen I/O Line.
Line1 (Display string: 'Line 1'): Encoder Reverse input is taken from the chosen I/O Line.
Line2 (Display string: 'Line 2'): Encoder Reverse input is taken from the chosen I/O Line.
Off (Display string: 'Off'): Counter is stopped.

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.

◆ getEncoderStatus()

PropertyI64 getEncoderStatus ( )

An enumerated integer property.

Returns the motion status of the encoder.

The following string values might be valid for this feature:

EncoderUp (Display string: 'Encoder Up'): The encoder counter last incremented.
EncoderDown (Display string: 'Encoder Down'): The encoder counter last decremented.
EncoderIdle (Display string: 'Encoder Idle'): The encoder is not active.
EncoderStatic (Display string: 'Encoder Static'): No motion within the EncoderTimeout time.

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.

◆ getEncoderTimeout()

PropertyF getEncoderTimeout ( )

A floating point property.

Sets the maximum time interval between encoder counter increments before the status turns to static.

◆ getEncoderValue()

PropertyI64 getEncoderValue ( )

An integer property.

Reads or writes the current value of the position counter of the selected Encoder.

◆ getEncoderValueAtReset()

PropertyI64 getEncoderValueAtReset ( )

An integer property.

Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command.

◆ swigRelease()

static long swigRelease ( EncoderControl obj )

staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protected

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EncoderControl() [1/3]

◆ EncoderControl() [2/3]

◆ EncoderControl() [3/3]

Member Function Documentation

◆ delete()

◆ finalize()

◆ getEncoderDivider()

◆ getEncoderMode()

◆ getEncoderOutputMode()

◆ getEncoderReset()

◆ getEncoderResetActivation()

◆ getEncoderResetSource()

◆ getEncoderResolution()

◆ getEncoderSelector()

◆ getEncoderSourceA()

◆ getEncoderSourceB()

◆ getEncoderStatus()

◆ getEncoderTimeout()

◆ getEncoderValue()

◆ getEncoderValueAtReset()

◆ swigRelease()

Member Data Documentation

◆ swigCMemOwn