mvSerialInterfaceControl Class Reference

Contains features to control the serial interface. More...

Inheritance diagram for mvSerialInterfaceControl:

Public Member Functions
synchronized void	delete ()
PropertyI64	getMvLiquidLensErrorCount ()
	An integer property.
PropertyI64	getMvLiquidLensFirmwareVersion ()
	An integer property.
PropertyI64	getMvLiquidLensPowerMode ()
	An enumerated integer property.
PropertyI64	getMvLiquidLensReceiveStatus ()
	An integer property.
Method	getMvLiquidLensSaveFocusValue ()
	A method object.
PropertyI64	getMvLiquidLensSetFocusValue ()
	An integer property.
PropertyI64	getMvLiquidLensStatus ()
	An enumerated integer property.
PropertyS	getMvSerialInterfaceASCIIBuffer ()
	A string property.
PropertyI64	getMvSerialInterfaceBaudRate ()
	An enumerated integer property.
PropertyS	getMvSerialInterfaceBinaryBuffer ()
	A string property.
PropertyI64	getMvSerialInterfaceBytesAvailableForRead ()
	An integer property.
PropertyI64	getMvSerialInterfaceBytesToRead ()
	An integer property.
PropertyI64	getMvSerialInterfaceBytesToWrite ()
	An integer property.
PropertyI64	getMvSerialInterfaceDataBits ()
	An enumerated integer property.
PropertyI	getMvSerialInterfaceEnable ()
	A boolean property.
PropertyI64	getMvSerialInterfaceMode ()
	An enumerated integer property.
PropertyI64	getMvSerialInterfaceParity ()
	An enumerated integer property.
Method	getMvSerialInterfaceRead ()
	A method object.
PropertyI64	getMvSerialInterfaceReceiveStatus ()
	An integer property.
PropertyI64	getMvSerialInterfaceStopBits ()
	An enumerated integer property.
Method	getMvSerialInterfaceWrite ()
	A method object.
PropertyF	getMvStepperAcceleration ()
	A floating point property.
PropertyI	getMvStepperAutoSavePositionEnable ()
	A boolean property.
PropertyI64	getMvStepperCurrentPosition ()
	An integer property.
PropertyI64	getMvStepperDesiredPosition ()
	An integer property.
PropertyI64	getMvStepperErrorCount ()
	An integer property.
PropertyI64	getMvStepperFirmwareVersion ()
	An integer property.
PropertyI64	getMvStepperMotorSelector ()
	An enumerated integer property.
Method	getMvStepperMoveToHomeAll ()
	A method object.
Method	getMvStepperPositionSetLoad ()
	A method object.
Method	getMvStepperPositionSetSave ()
	A method object.
PropertyI64	getMvStepperPositionSetSelector ()
	An integer property.
PropertyI64	getMvStepperReceiveStatus ()
	An integer property.
PropertyF	getMvStepperSpeed ()
	A floating point property.
PropertyF	getMvStepperSpeedManual ()
	A floating point property.
PropertyI64	getMvStepperStatus ()
	An enumerated integer property.
Method	getMvStepperStopAll ()
	A method object.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	mvSerialInterfaceControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvSerialInterfaceControl object.
	mvSerialInterfaceControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvSerialInterfaceControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

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

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (mvSerialInterfaceControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Contains features to control the serial interface.

Contains features to control the serial interface.

Constructor & Destructor Documentation

mvSerialInterfaceControl() [1/3]

mvSerialInterfaceControl ( long cPtr, boolean cMemoryOwn )

protected

mvSerialInterfaceControl() [2/3]

mvSerialInterfaceControl	(	Device	pDev,
		String	settingName )

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

mvSerialInterfaceControl() [3/3]

mvSerialInterfaceControl

(

Device

pDev

)

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

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getMvLiquidLensErrorCount()

PropertyI64 getMvLiquidLensErrorCount

(

)

An integer property.

This register increments whenever an error occurred while communicating with the Liquid Lens.

This register increments whenever an error occurred while communicating with the Liquid Lens.

getMvLiquidLensFirmwareVersion()

PropertyI64 getMvLiquidLensFirmwareVersion

(

)

An integer property.

Returns the firmware version of the Liquid Lens.

Returns the firmware version of the Liquid Lens.

getMvLiquidLensPowerMode()

PropertyI64 getMvLiquidLensPowerMode

(

)

An enumerated integer property.

Selects the device power mode.

Selects the device power mode.

The following string values might be valid for this feature:

• mvLiquidLensActive (Display string: 'mv Liquid Lens Active'): Puts the device to power-active mode.
• mvLiquidLensStandby (Display string: 'mv Liquid Lens Standby'): Puts the Liquid Lens in power-saving mode. In this mode the device will only consume up to 25 percent of its normal power consumption.

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.

getMvLiquidLensReceiveStatus()

PropertyI64 getMvLiquidLensReceiveStatus

(

)

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: CRC Error, 0x2: NAK received, 0x4: No response, 0x8 Incorrect answer received.

getMvLiquidLensSaveFocusValue()

Method getMvLiquidLensSaveFocusValue

(

)

A method object.

Saves the current Focus position into LiquidLens EEPROM.

Saves the current Focus position into LiquidLens EEPROM.

getMvLiquidLensSetFocusValue()

PropertyI64 getMvLiquidLensSetFocusValue

(

)

An integer property.

Focus position value for Liquid Lens.

Focus position value for Liquid Lens.

getMvLiquidLensStatus()

PropertyI64 getMvLiquidLensStatus

(

)

An enumerated integer property.

Returns the current status of the Liquid Lens.

Returns the current status of the Liquid Lens.

The following string values might be valid for this feature:

• NoError (Display string: 'No Error'): No Errors.
• VhOverload (Display string: 'Vh Overload'): Vh below 70V because Liquid Lens is taking too much current.
• ThermalOverload (Display string: 'Thermal Overload'): Driver shutdown because Liquid Lens is too hot.
• VhAndThermalOverload (Display string: 'Vh And Thermal Overload'): Vh does not reach 70V and driver shutdown because Liquid Lens is too hot.
• StatusReadErrorNoAnswer (Display string: 'Status Read Error No Answer'): No response from Liquid Lens.
• StatusReadErrorCRC (Display string: 'Status Read Error CRC'): CRC error in response from Liquid Lens.
• StatusReadErrorNakAnswer (Display string: 'Status Read Error Nak Answer'): NAK response from Liquid Lens.
• StatusReadErrorInvalidAnswer (Display string: 'Status Read Error Invalid Answer'): Invalid Size or Command in response from Liquid Lens.

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.

getMvSerialInterfaceASCIIBuffer()

PropertyS getMvSerialInterfaceASCIIBuffer

(

)

A string property.

Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.

Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.

getMvSerialInterfaceBaudRate()

PropertyI64 getMvSerialInterfaceBaudRate

(

)

An enumerated integer property.

Serial interface clock frequency.

Serial interface clock frequency.

The following string values might be valid for this feature:

• Hz_115200 (Display string: '115200 Hz')
• Hz_57600 (Display string: '57600 Hz')
• Hz_38400 (Display string: '38400 Hz')
• Hz_19200 (Display string: '19200 Hz')
• Hz_9600 (Display string: '9600 Hz')

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.

getMvSerialInterfaceBinaryBuffer()

PropertyS getMvSerialInterfaceBinaryBuffer

(

)

A string property.

Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.

Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.

getMvSerialInterfaceBytesAvailableForRead()

PropertyI64 getMvSerialInterfaceBytesAvailableForRead

(

)

An integer property.

Number of serial data bytes available for read.

Number of serial data bytes available for read.

getMvSerialInterfaceBytesToRead()

PropertyI64 getMvSerialInterfaceBytesToRead

(

)

An integer property.

Number of serial bytes to read.

Number of serial bytes to read.

getMvSerialInterfaceBytesToWrite()

PropertyI64 getMvSerialInterfaceBytesToWrite

(

)

An integer property.

Length of data to write.

Length of data to write.

getMvSerialInterfaceDataBits()

PropertyI64 getMvSerialInterfaceDataBits

(

)

An enumerated integer property.

Number of data bits.

Number of data bits.

The following string values might be valid for this feature:

• Seven (Display string: 'Seven')
• Eight (Display string: 'Eight')
• Nine (Display string: 'Nine')

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.

getMvSerialInterfaceEnable()

PropertyI getMvSerialInterfaceEnable

(

)

A boolean property.

Controls whether the serial interface is enabled or not.

Controls whether the serial interface is enabled or not.

getMvSerialInterfaceMode()

PropertyI64 getMvSerialInterfaceMode

(

)

An enumerated integer property.

States the interface mode of the serial interface

States the interface mode of the serial interface

The following string values might be valid for this feature:

• Plain (Display string: 'Plain')
• InveniosLiquidLens (Display string: 'Invenios Liquid Lens')
• OptoEngineeringStepper (Display string: 'Opto Engineering Stepper')

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.

getMvSerialInterfaceParity()

PropertyI64 getMvSerialInterfaceParity

(

)

An enumerated integer property.

Serial interface parity.

Serial interface parity.

The following string values might be valid for this feature:

• None (Display string: 'None')
• Odd (Display string: 'Odd')
• Even (Display string: 'Even')

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.

getMvSerialInterfaceRead()

Method getMvSerialInterfaceRead

(

)

A method object.

Command to read data from serial interface.

Command to read data from serial interface.

getMvSerialInterfaceReceiveStatus()

PropertyI64 getMvSerialInterfaceReceiveStatus

(

)

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism.

getMvSerialInterfaceStopBits()

PropertyI64 getMvSerialInterfaceStopBits

(

)

An enumerated integer property.

Number of stop bits.

Number of stop bits.

The following string values might be valid for this feature:

• One (Display string: 'One')
• Two (Display string: 'Two')

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.

getMvSerialInterfaceWrite()

Method getMvSerialInterfaceWrite

(

)

A method object.

Command to write data to serial interface

Command to write data to serial interface

getMvStepperAcceleration()

PropertyF getMvStepperAcceleration

(

)

A floating point property.

Current acceleration of the selected stepper motor.

Current acceleration of the selected stepper motor.

getMvStepperAutoSavePositionEnable()

PropertyI getMvStepperAutoSavePositionEnable

(

)

A boolean property.

Controls if the auto-save of motor positions is active.

Controls if the auto-save of motor positions is active.

getMvStepperCurrentPosition()

PropertyI64 getMvStepperCurrentPosition

(

)

An integer property.

Read current position from stepper.

Read current position from stepper.

getMvStepperDesiredPosition()

PropertyI64 getMvStepperDesiredPosition

(

)

An integer property.

The desired position of the selected stepper motor.

The desired position of the selected stepper motor. When the motor has not yet reached this position(is moving) this value may differ from 'mvStepperCurrentPosition'.

getMvStepperErrorCount()

PropertyI64 getMvStepperErrorCount

(

)

An integer property.

This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.

This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.

getMvStepperFirmwareVersion()

PropertyI64 getMvStepperFirmwareVersion

(

)

An integer property.

Returns the firmware version of the Opto Engineering Stepper.

Returns the firmware version of the Opto Engineering Stepper.

getMvStepperMotorSelector()

PropertyI64 getMvStepperMotorSelector

(

)

An enumerated integer property.

Selects the stepper motor to control.

Selects the stepper motor to control(Zoom, Iris or Focus).

The following string values might be valid for this feature:

• All (Display string: 'All'): All stepper motors are selected.
• Zoom (Display string: 'Zoom'): Selects the stepper motor controlling the zoom.
• Focus (Display string: 'Focus'): Selects the stepper motor controlling the focus.
• Iris (Display string: 'Iris'): Selects the stepper motor controlling the iris.

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.

getMvStepperMoveToHomeAll()

Method getMvStepperMoveToHomeAll

(

)

A method object.

Moves all stepper motors to their home position.

Moves all stepper motors to their home position.

getMvStepperPositionSetLoad()

Method getMvStepperPositionSetLoad

(

)

A method object.

Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.

Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.

getMvStepperPositionSetSave()

Method getMvStepperPositionSetSave

(

)

A method object.

Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.

Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.

getMvStepperPositionSetSelector()

PropertyI64 getMvStepperPositionSetSelector

(

)

An integer property.

Selects the stepper parameter set to load or save.

Selects the stepper parameter set to load or save.

getMvStepperReceiveStatus()

PropertyI64 getMvStepperReceiveStatus

(

)

An integer property.

Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism. This is a bit field. The bits have the following meaning: 0x1: Reserved, 0x2: Mismatch in answer detected, 0x4: No response, 0x8 Incorrect answer received.

getMvStepperSpeed()

PropertyF getMvStepperSpeed

(

)

A floating point property.

Current speed of the selected stepper motor.

Current speed of the selected stepper motor.

getMvStepperSpeedManual()

PropertyF getMvStepperSpeedManual

(

)

A floating point property.

Manual speed of the selected stepper motor.

Manual speed of the selected stepper motor.

getMvStepperStatus()

PropertyI64 getMvStepperStatus

(

)

An enumerated integer property.

Returns the current status of the stepper.

Returns the current status of the stepper.

The following string values might be valid for this feature:

• Unknown (Display string: 'Unknown'): The current status of the stepper is unknown.
• Moving (Display string: 'Moving'): The selected stepper motor is currently moving.
• StoppedAtLowerLimitWithTorque (Display string: 'Stopped At Lower Limit With Torque'): The selected stepper motor has stopped at its lower limit with torque(this should never happen and indicates a problem).
• StoppedAtLowerLimit (Display string: 'Stopped At Lower Limit'): The selected stepper motor has stopped at its lower limit.
• StoppedAtUpperLimitWithTorque (Display string: 'Stopped At Upper Limit With Torque'): The selected stepper motor has stopped at its upper limit with torque(this should never happen and indicates a problem).
• StoppedAtUpperLimit (Display string: 'Stopped At Upper Limit'): The selected stepper motor has stopped at its upper limit.
• StoppedWithTorque (Display string: 'Stopped With Torque'): The selected stepper motor has stopped with torque(this should never happen and indicates a problem).
• Stopped (Display string: 'Stopped'): The selected stepper motor has stopped.
• OvercurrentOrOvertemperatureError (Display string: 'Overcurrent Or Overtemperature Error'): The selected stepper motor either became too hot or is taking in too much current(this should never happen and indicates a problem).

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.

getMvStepperStopAll()

Method getMvStepperStopAll

(

)

A method object.

Stops all stepper motors.

Stops all stepper motors.

hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( mvSerialInterfaceControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited