mvIMPACT Acquire SDK C++

Contains features to control motorized lenses. More...

Inheritance diagram for mvLensControl:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvLensControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvLensControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

Method mvDriveBackward
 A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction. More...
 
PropertyI64 mvDriveDuration
 An integer property. Sets the duration of the drive command in us. More...
 
Method mvDriveForward
 A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction. More...
 
PropertyI64 mvDriveLevel
 An integer property. Sets the voltage level of the drive command in mV. More...
 
PropertyI64 mvDriveSelector
 An enumerated integer property. Selects the lens drive that should be adjusted. More...
 
PropertyI64 mvIrisMode
 An enumerated integer property. Sets the iris operating mode. More...
 
PropertyI64 mvIrisSignalLevelMax
 An integer property. Sets the maximum iris signal level in mV. More...
 
PropertyI64 mvIrisSignalLevelMin
 An integer property. Sets the minimum iris signal level in mV. More...
 
PropertyI64 mvIrisType
 An enumerated integer property. Sets the iris type. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Contains features to control motorized lenses.

Contains features to control motorized lenses.

Constructor & Destructor Documentation

◆ mvLensControl()

mvLensControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvLensControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

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

◆ mvDriveBackward

Method mvDriveBackward

A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

◆ mvDriveDuration

PropertyI64 mvDriveDuration

An integer property. Sets the duration of the drive command in us.

Sets the duration of the drive command in us.

◆ mvDriveForward

Method mvDriveForward

A method object. Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

◆ mvDriveLevel

PropertyI64 mvDriveLevel

An integer property. Sets the voltage level of the drive command in mV.

Sets the voltage level of the drive command in mV.

◆ mvDriveSelector

PropertyI64 mvDriveSelector

An enumerated integer property. Selects the lens drive that should be adjusted.

Selects the lens drive that should be adjusted.

The following string values might be valid for this feature:

  • mvFocus (Display string: 'mv Focus'): Selects the motor to control the focus.
  • mvZoom (Display string: 'mv Zoom'): Selects the motor to control the zoom.
  • mvIris (Display string: 'mv Iris'): Selects the motor to control 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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvIrisMode

PropertyI64 mvIrisMode

An enumerated integer property. Sets the iris operating mode.

Sets the iris operating mode.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): No iris adjustment will be done.
  • mvIrisAuto (Display string: 'mv Iris Auto'): The iris adjustment will be done automatically by evaluating the current image data.
  • mvIrisOpen (Display string: 'mv Iris Open'): The iris is fully open.
  • mvIrisClose (Display string: 'mv Iris Close'): The iris is fully closed.
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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvIrisSignalLevelMax

PropertyI64 mvIrisSignalLevelMax

An integer property. Sets the maximum iris signal level in mV.

Sets the maximum iris signal level in mV.

◆ mvIrisSignalLevelMin

PropertyI64 mvIrisSignalLevelMin

An integer property. Sets the minimum iris signal level in mV.

Sets the minimum iris signal level in mV.

◆ mvIrisType

PropertyI64 mvIrisType

An enumerated integer property. Sets the iris type.

Sets the iris type.

The following string values might be valid for this feature:

  • mvVideoIris (Display string: 'mv Video 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::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

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