Impact Acquire SDK Java
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
mvLensControl Class Reference
GenICam Interface Layout » GenICam Interface Layout (Device)

Contains features to control motorized lenses. More...

Inheritance diagram for mvLensControl:
[legend]

Public Member Functions

synchronized void delete ()
 
Method getMvDriveBackward ()
 A method object.
 
PropertyI64 getMvDriveDuration ()
 An integer property.
 
Method getMvDriveForward ()
 A method object.
 
PropertyI64 getMvDriveLevel ()
 An integer property.
 
PropertyI64 getMvDriveSelector ()
 An enumerated integer property.
 
PropertyI64 getMvIrisMode ()
 An enumerated integer property.
 
PropertyI64 getMvIrisSignalLevelMax ()
 An integer property.
 
PropertyI64 getMvIrisSignalLevelMin ()
 An integer property.
 
PropertyI64 getMvIrisType ()
 An enumerated integer property.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
 mvLensControl (Device pDev)
 Constructs a new mvIMPACT.acquire.mvLensControl object.
 
 mvLensControl (Device pDev, String settingName)
 Constructs a new mvIMPACT.acquire.mvLensControl object.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 

Protected Member Functions

void finalize ()
 
 mvLensControl (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
 
static long swigRelease (mvLensControl obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Contains features to control motorized lenses.

Contains features to control motorized lenses.

Constructor & Destructor Documentation

◆ mvLensControl() [1/3]

mvLensControl ( long cPtr,
boolean cMemoryOwn )
protected

◆ mvLensControl() [2/3]

mvLensControl ( Device pDev,
String settingName )

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

◆ mvLensControl() [3/3]

mvLensControl ( Device pDev)

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

◆ getMvDriveBackward()

Method getMvDriveBackward ( )

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.

◆ getMvDriveDuration()

PropertyI64 getMvDriveDuration ( )

An integer property.

Sets the duration of the drive command in us.

Sets the duration of the drive command in us.

◆ getMvDriveForward()

Method getMvDriveForward ( )

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.

◆ getMvDriveLevel()

PropertyI64 getMvDriveLevel ( )

An integer property.

Sets the voltage level of the drive command in mV.

Sets the voltage level of the drive command in mV.

◆ getMvDriveSelector()

PropertyI64 getMvDriveSelector ( )

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ getMvIrisMode()

PropertyI64 getMvIrisMode ( )

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ getMvIrisSignalLevelMax()

PropertyI64 getMvIrisSignalLevelMax ( )

An integer property.

Sets the maximum iris signal level in mV.

Sets the maximum iris signal level in mV.

◆ getMvIrisSignalLevelMin()

PropertyI64 getMvIrisSignalLevelMin ( )

An integer property.

Sets the minimum iris signal level in mV.

Sets the minimum iris signal level in mV.

◆ getMvIrisType()

PropertyI64 getMvIrisType ( )

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.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ 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 ( mvLensControl obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited