mvIMPACT Acquire SDK C++
MotorFocusControl Class Reference

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

Inheritance diagram for MotorFocusControl:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 MotorFocusControl (Device *pDev)
 brief Constructs a new mvIMPACT::acquire::MotorFocusControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI motorFocusAbsolutePositionCurrent
 An integer property (read-only) storing the current absolute position(in encoder counts). More...
 
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. More...
 
Method motorFocusFar
 Calling this function will cause the motor focus to move backward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units. More...
 
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. More...
 
Method motorFocusMoveToAbsolutePositionDesired
 Calling this function will cause the motor focus to move to the position defined by the value of mvIMPACT::acquire::MotorFocusControl::motorFocusAbsolutePositionDesired. More...
 
Method motorFocusNear
 Calling this function will cause the motor focus to move forward by mvIMPACT::acquire::MotorFocusControl::motorFocusIncrement encoder units. More...
 
PropertyS motorFocusReceiveBuffer
 A string property (read-only) that will contain answers sent by the motor focus controller. More...
 
Method motorFocusSend
 Calling this function will send the value of mvIMPACT::acquire::MotorFocusControl::motorFocusSendBuffer to the hardware. More...
 
PropertyS motorFocusSendBuffer
 A string property storing a command to be sent to the motor focus. More...
 

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


The documentation for this class was generated from the following file: