Properties for configuring settings belonging to the motor focus control (Device specific interface layout only). More...

#include <mvIMPACT_acquire.h>

Inheritance diagram for MotorFocusControl:

[legend]

Public Member Functions
HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.

	MotorFocusControl (Device *pDev)
	brief Constructs a new mvIMPACT::acquire::MotorFocusControl object.

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

Public Attributes
PropertyI	motorFocusAbsolutePositionCurrent
	An integer property (read-only) storing the current absolute position(in encoder counts).

PropertyI	motorFocusAbsolutePositionDesired
	An integer property storing an absolute position(in encoder counts) that will be used by subsequent calls to the mvIMPACT::acquire::MotorFocusControl::motorFocusMoveToAbsolutePositionDesired command.

Method	motorFocusFar
	Calling this function will cause the motor focus to move backward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units.

PropertyI	motorFocusIncrement
	An integer property storing an increment(in encoder counts) that will be used by subsequent calls to mvIMPACT::acquire::MotorFocusControl::motorFocusNear and mvIMPACT::acquire::MotorFocusControl::motorFocusFar commands.

Method	motorFocusMoveToAbsolutePositionDesired
	Calling this function will cause the motor focus to move to the position defined by the value of mvIMPACT::acquire::MotorFocusControl::motorFocusAbsolutePositionDesired.

Method	motorFocusNear
	Calling this function will cause the motor focus to move forward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units.

PropertyS	motorFocusReceiveBuffer
	A string property (read-only) that will contain answers sent by the motor focus controller.

Method	motorFocusSend
	Calling this function will send the value of mvIMPACT::acquire::MotorFocusControl::motorFocusSendBuffer to the hardware.

PropertyS	motorFocusSendBuffer
	A string property storing a command to be sent to the motor focus.

Protected Attributes
HOBJ	m_hRoot

Detailed Description

Properties for configuring settings belonging to the motor focus control (Device specific interface layout only).

Properties in this class will only be available if a device is fitted with a focus motor.

Note: This class will only be available if mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ MotorFocusControl()

MotorFocusControl ( Device * pDev )

inlineexplicit

brief Constructs a new mvIMPACT::acquire::MotorFocusControl object.

Parameters

[in] pDev A pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.

Member Function Documentation

◆ hObj()

HOBJ hObj ( void ) const

inlineinherited

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()

const ComponentCollection & restoreDefault ( void ) const

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.

Returns: A const reference to the component.

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot

protectedinherited

◆ motorFocusAbsolutePositionCurrent

PropertyI motorFocusAbsolutePositionCurrent

An integer property (read-only) storing the current absolute position(in encoder counts).

◆ motorFocusAbsolutePositionDesired

PropertyI motorFocusAbsolutePositionDesired

An integer property storing an absolute position(in encoder counts) that will be used by subsequent calls to the mvIMPACT::acquire::MotorFocusControl::motorFocusMoveToAbsolutePositionDesired command.

◆ motorFocusFar

Method motorFocusFar

Calling this function will cause the motor focus to move backward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units.

◆ motorFocusIncrement

PropertyI motorFocusIncrement

An integer property storing an increment(in encoder counts) that will be used by subsequent calls to mvIMPACT::acquire::MotorFocusControl::motorFocusNear and mvIMPACT::acquire::MotorFocusControl::motorFocusFar commands.

◆ motorFocusMoveToAbsolutePositionDesired

Method motorFocusMoveToAbsolutePositionDesired

Calling this function will cause the motor focus to move to the position defined by the value of mvIMPACT::acquire::MotorFocusControl::motorFocusAbsolutePositionDesired.

◆ motorFocusNear

Method motorFocusNear

Calling this function will cause the motor focus to move forward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units.

◆ motorFocusReceiveBuffer

PropertyS motorFocusReceiveBuffer

A string property (read-only) that will contain answers sent by the motor focus controller.

◆ motorFocusSend

Method motorFocusSend

Calling this function will send the value of mvIMPACT::acquire::MotorFocusControl::motorFocusSendBuffer to the hardware.

Afterwards mvIMPACT::acquire::MotorFocusControl::motorFocusReceiveBuffer will contain the hardwares answer.

◆ motorFocusSendBuffer

PropertyS motorFocusSendBuffer

A string property storing a command to be sent to the motor focus.

To actually send the command, the function mvIMPACT::acquire::MotorFocusControl::motorFocusSend must be executed.

Public Member Functions

Public Attributes

Protected Attributes