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

Inheritance diagram for mvSerialInterfaceControl:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.

IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.

	mvSerialInterfaceControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvSerialInterfaceControl object.

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

void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyI64	mvLiquidLensErrorCount = new mv.impact.acquire.PropertyI64()
	An integer property. This register increments whenever an error occurred while communicating with the Liquid Lens.

readonly mv.impact.acquire.PropertyI64	mvLiquidLensFirmwareVersion = new mv.impact.acquire.PropertyI64()
	An integer property. Returns the firmware version of the Liquid Lens.

readonly mv.impact.acquire.PropertyI64	mvLiquidLensPowerMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the device power mode.

readonly mv.impact.acquire.PropertyI64	mvLiquidLensReceiveStatus = new mv.impact.acquire.PropertyI64()
	An integer property. Result of the serial receive error detection mechanism.

readonly mv.impact.acquire.Method	mvLiquidLensSaveFocusValue = new mv.impact.acquire.Method()
	A method object. Saves the current Focus position into LiquidLens EEPROM.

readonly mv.impact.acquire.PropertyI64	mvLiquidLensSetFocusValue = new mv.impact.acquire.PropertyI64()
	An integer property. Focus position value for Liquid Lens.

readonly mv.impact.acquire.PropertyI64	mvLiquidLensStatus = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Returns the current status of the Liquid Lens.

readonly mv.impact.acquire.PropertyS	mvSerialInterfaceASCIIBuffer = new mv.impact.acquire.PropertyS()
	A string property. Buffer for exchanging ASCII data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceBinaryBuffer'.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceBaudRate = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Serial interface clock frequency.

readonly mv.impact.acquire.PropertyS	mvSerialInterfaceBinaryBuffer = new mv.impact.acquire.PropertyS()
	A string property. Buffer for exchanging binary data over the serial interface. This buffer uses the same memory as 'mvSerialInterfaceASCIIBuffer'.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceBytesAvailableForRead = new mv.impact.acquire.PropertyI64()
	An integer property. Number of serial data bytes available for read.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceBytesToRead = new mv.impact.acquire.PropertyI64()
	An integer property. Number of serial bytes to read.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceBytesToWrite = new mv.impact.acquire.PropertyI64()
	An integer property. Length of data to write.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceDataBits = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Number of data bits.

readonly mv.impact.acquire.PropertyIBoolean	mvSerialInterfaceEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Controls whether the serial interface is enabled or not.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. States the interface mode of the serial interface.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceParity = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Serial interface parity.

readonly mv.impact.acquire.Method	mvSerialInterfaceRead = new mv.impact.acquire.Method()
	A method object. Command to read data from serial interface.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceReceiveStatus = new mv.impact.acquire.PropertyI64()
	An integer property. Result of the serial receive error detection mechanism.

readonly mv.impact.acquire.PropertyI64	mvSerialInterfaceStopBits = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Number of stop bits.

readonly mv.impact.acquire.Method	mvSerialInterfaceWrite = new mv.impact.acquire.Method()
	A method object. Command to write data to serial interface.

readonly mv.impact.acquire.PropertyF	mvStepperAcceleration = new mv.impact.acquire.PropertyF()
	A floating point property. Current acceleration of the selected stepper motor.

readonly mv.impact.acquire.PropertyIBoolean	mvStepperAutoSavePositionEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Controls if the auto-save of motor positions is active.

readonly mv.impact.acquire.PropertyI64	mvStepperCurrentPosition = new mv.impact.acquire.PropertyI64()
	An integer property. Read current position from stepper.

readonly mv.impact.acquire.PropertyI64	mvStepperDesiredPosition = new mv.impact.acquire.PropertyI64()
	An integer property. The desired position of the selected stepper motor.

readonly mv.impact.acquire.PropertyI64	mvStepperErrorCount = new mv.impact.acquire.PropertyI64()
	An integer property. This register increments whenever an error occurred while communicating with the Opto Engineering Stepper.

readonly mv.impact.acquire.PropertyI64	mvStepperFirmwareVersion = new mv.impact.acquire.PropertyI64()
	An integer property. Returns the firmware version of the Opto Engineering Stepper.

readonly mv.impact.acquire.PropertyI64	mvStepperMotorSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the stepper motor to control.

readonly mv.impact.acquire.Method	mvStepperMoveToHomeAll = new mv.impact.acquire.Method()
	A method object. Moves all stepper motors to their home position.

readonly mv.impact.acquire.Method	mvStepperPositionSetLoad = new mv.impact.acquire.Method()
	A method object. Loads the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' and makes it active for each motor.

readonly mv.impact.acquire.Method	mvStepperPositionSetSave = new mv.impact.acquire.Method()
	A method object. Saves the stepper 'mvStepperDesiredPosition' specified by 'mvStepperPositionSetSelector' into the steppers non-volatile memory for each motor.

readonly mv.impact.acquire.PropertyI64	mvStepperPositionSetSelector = new mv.impact.acquire.PropertyI64()
	An integer property. Selects the stepper parameter set to load or save.

readonly mv.impact.acquire.PropertyI64	mvStepperReceiveStatus = new mv.impact.acquire.PropertyI64()
	An integer property. Result of the serial receive error detection mechanism.

readonly mv.impact.acquire.PropertyF	mvStepperSpeed = new mv.impact.acquire.PropertyF()
	A floating point property. Current speed of the selected stepper motor.

readonly mv.impact.acquire.PropertyF	mvStepperSpeedManual = new mv.impact.acquire.PropertyF()
	A floating point property. Manual speed of the selected stepper motor.

readonly mv.impact.acquire.PropertyI64	mvStepperStatus = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Returns the current status of the stepper.

readonly mv.impact.acquire.Method	mvStepperStopAll = new mv.impact.acquire.Method()
	A method object. Stops all stepper motors.

Properties
IEnumerable< Component >	componentEnumerable `[get]`
	Returns an enumerator that iterates through the collection.

IEnumerable< ComponentList >	componentListEnumerable `[get]`
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

int	hObj `[get]`
	Returns a unique identifier for the component collection referenced by this object.

Detailed Description

Contains features to control the serial interface.

Constructor & Destructor Documentation

◆ mvSerialInterfaceControl() [1/2]

mvSerialInterfaceControl ( mv::impact::acquire::Device device )

inline

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

Parameters

[in] device A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ mvSerialInterfaceControl() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ restoreDefault()

void restoreDefault ( )

inlineinherited

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.

Member Data Documentation

◆ mvLiquidLensErrorCount

readonly mv.impact.acquire.PropertyI64 mvLiquidLensErrorCount = new mv.impact.acquire.PropertyI64()

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.

◆ mvLiquidLensFirmwareVersion

readonly mv.impact.acquire.PropertyI64 mvLiquidLensFirmwareVersion = new mv.impact.acquire.PropertyI64()

An integer property. Returns the firmware version of the Liquid Lens.

Returns the firmware version of the Liquid Lens.

◆ mvLiquidLensPowerMode

readonly mv.impact.acquire.PropertyI64 mvLiquidLensPowerMode = new mv.impact.acquire.PropertyI64()

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

◆ mvLiquidLensReceiveStatus

readonly mv.impact.acquire.PropertyI64 mvLiquidLensReceiveStatus = new mv.impact.acquire.PropertyI64()

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.

◆ mvLiquidLensSaveFocusValue

readonly mv.impact.acquire.Method mvLiquidLensSaveFocusValue = new mv.impact.acquire.Method()

A method object. Saves the current Focus position into LiquidLens EEPROM.

Saves the current Focus position into LiquidLens EEPROM.

◆ mvLiquidLensSetFocusValue

readonly mv.impact.acquire.PropertyI64 mvLiquidLensSetFocusValue = new mv.impact.acquire.PropertyI64()

An integer property. Focus position value for Liquid Lens.

Focus position value for Liquid Lens.

◆ mvLiquidLensStatus

readonly mv.impact.acquire.PropertyI64 mvLiquidLensStatus = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceASCIIBuffer

readonly mv.impact.acquire.PropertyS mvSerialInterfaceASCIIBuffer = new mv.impact.acquire.PropertyS()

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

◆ mvSerialInterfaceBaudRate

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceBaudRate = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceBinaryBuffer

readonly mv.impact.acquire.PropertyS mvSerialInterfaceBinaryBuffer = new mv.impact.acquire.PropertyS()

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

◆ mvSerialInterfaceBytesAvailableForRead

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceBytesAvailableForRead = new mv.impact.acquire.PropertyI64()

An integer property. Number of serial data bytes available for read.

Number of serial data bytes available for read.

◆ mvSerialInterfaceBytesToRead

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceBytesToRead = new mv.impact.acquire.PropertyI64()

An integer property. Number of serial bytes to read.

Number of serial bytes to read.

◆ mvSerialInterfaceBytesToWrite

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceBytesToWrite = new mv.impact.acquire.PropertyI64()

An integer property. Length of data to write.

Length of data to write.

◆ mvSerialInterfaceDataBits

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceDataBits = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceEnable

readonly mv.impact.acquire.PropertyIBoolean mvSerialInterfaceEnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Controls whether the serial interface is enabled or not.

Controls whether the serial interface is enabled or not.

◆ mvSerialInterfaceMode

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceMode = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceParity

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceParity = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceRead

readonly mv.impact.acquire.Method mvSerialInterfaceRead = new mv.impact.acquire.Method()

A method object. Command to read data from serial interface.

Command to read data from serial interface.

◆ mvSerialInterfaceReceiveStatus

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceReceiveStatus = new mv.impact.acquire.PropertyI64()

An integer property. Result of the serial receive error detection mechanism.

Result of the serial receive error detection mechanism.

◆ mvSerialInterfaceStopBits

readonly mv.impact.acquire.PropertyI64 mvSerialInterfaceStopBits = new mv.impact.acquire.PropertyI64()

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

◆ mvSerialInterfaceWrite

readonly mv.impact.acquire.Method mvSerialInterfaceWrite = new mv.impact.acquire.Method()

A method object. Command to write data to serial interface.

Command to write data to serial interface

◆ mvStepperAcceleration

readonly mv.impact.acquire.PropertyF mvStepperAcceleration = new mv.impact.acquire.PropertyF()

A floating point property. Current acceleration of the selected stepper motor.

Current acceleration of the selected stepper motor.

◆ mvStepperAutoSavePositionEnable

readonly mv.impact.acquire.PropertyIBoolean mvStepperAutoSavePositionEnable = new mv.impact.acquire.PropertyIBoolean()

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

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

◆ mvStepperCurrentPosition

readonly mv.impact.acquire.PropertyI64 mvStepperCurrentPosition = new mv.impact.acquire.PropertyI64()

An integer property. Read current position from stepper.

Read current position from stepper.

◆ mvStepperDesiredPosition

readonly mv.impact.acquire.PropertyI64 mvStepperDesiredPosition = new mv.impact.acquire.PropertyI64()

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

◆ mvStepperErrorCount

readonly mv.impact.acquire.PropertyI64 mvStepperErrorCount = new mv.impact.acquire.PropertyI64()

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.

◆ mvStepperFirmwareVersion

readonly mv.impact.acquire.PropertyI64 mvStepperFirmwareVersion = new mv.impact.acquire.PropertyI64()

An integer property. Returns the firmware version of the Opto Engineering Stepper.

Returns the firmware version of the Opto Engineering Stepper.

◆ mvStepperMotorSelector

readonly mv.impact.acquire.PropertyI64 mvStepperMotorSelector = new mv.impact.acquire.PropertyI64()

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

◆ mvStepperMoveToHomeAll

readonly mv.impact.acquire.Method mvStepperMoveToHomeAll = new mv.impact.acquire.Method()

A method object. Moves all stepper motors to their home position.

Moves all stepper motors to their home position.

◆ mvStepperPositionSetLoad

readonly mv.impact.acquire.Method mvStepperPositionSetLoad = new mv.impact.acquire.Method()

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.

◆ mvStepperPositionSetSave

readonly mv.impact.acquire.Method mvStepperPositionSetSave = new mv.impact.acquire.Method()

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.

◆ mvStepperPositionSetSelector

readonly mv.impact.acquire.PropertyI64 mvStepperPositionSetSelector = new mv.impact.acquire.PropertyI64()

An integer property. Selects the stepper parameter set to load or save.

Selects the stepper parameter set to load or save.

◆ mvStepperReceiveStatus

readonly mv.impact.acquire.PropertyI64 mvStepperReceiveStatus = new mv.impact.acquire.PropertyI64()

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.

◆ mvStepperSpeed

readonly mv.impact.acquire.PropertyF mvStepperSpeed = new mv.impact.acquire.PropertyF()

A floating point property. Current speed of the selected stepper motor.

Current speed of the selected stepper motor.

◆ mvStepperSpeedManual

readonly mv.impact.acquire.PropertyF mvStepperSpeedManual = new mv.impact.acquire.PropertyF()

A floating point property. Manual speed of the selected stepper motor.

Manual speed of the selected stepper motor.

◆ mvStepperStatus

readonly mv.impact.acquire.PropertyI64 mvStepperStatus = new mv.impact.acquire.PropertyI64()

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

◆ mvStepperStopAll

readonly mv.impact.acquire.Method mvStepperStopAll = new mv.impact.acquire.Method()

A method object. Stops all stepper motors.

Stops all stepper motors.

Property Documentation

◆ componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns: An enumerator that iterates through the collection

◆ hObj

int hObj

getinherited

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

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

Returns: A unique identifier for the component referenced by this object.

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ mvSerialInterfaceControl() [1/2]

◆ mvSerialInterfaceControl() [2/2]

Member Function Documentation

◆ getEnumerable< T >()

◆ GetEnumerator()

◆ restoreDefault()

Member Data Documentation

◆ mvLiquidLensErrorCount

◆ mvLiquidLensFirmwareVersion

◆ mvLiquidLensPowerMode

◆ mvLiquidLensReceiveStatus

◆ mvLiquidLensSaveFocusValue

◆ mvLiquidLensSetFocusValue

◆ mvLiquidLensStatus

◆ mvSerialInterfaceASCIIBuffer

◆ mvSerialInterfaceBaudRate

◆ mvSerialInterfaceBinaryBuffer

◆ mvSerialInterfaceBytesAvailableForRead

◆ mvSerialInterfaceBytesToRead

◆ mvSerialInterfaceBytesToWrite

◆ mvSerialInterfaceDataBits

◆ mvSerialInterfaceEnable

◆ mvSerialInterfaceMode

◆ mvSerialInterfaceParity

◆ mvSerialInterfaceRead

◆ mvSerialInterfaceReceiveStatus

◆ mvSerialInterfaceStopBits

◆ mvSerialInterfaceWrite

◆ mvStepperAcceleration

◆ mvStepperAutoSavePositionEnable

◆ mvStepperCurrentPosition

◆ mvStepperDesiredPosition

◆ mvStepperErrorCount

◆ mvStepperFirmwareVersion

◆ mvStepperMotorSelector

◆ mvStepperMoveToHomeAll

◆ mvStepperPositionSetLoad

◆ mvStepperPositionSetSave

◆ mvStepperPositionSetSelector

◆ mvStepperReceiveStatus

◆ mvStepperSpeed

◆ mvStepperSpeedManual

◆ mvStepperStatus

◆ mvStepperStopAll

Property Documentation

◆ componentEnumerable

◆ componentListEnumerable

◆ hObj