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

Contains convenience functions to control features understood by Birger Engineering, Inc. More...

Inheritance diagram for LensControlBirger:
[legend]

Public Member Functions

synchronized void delete ()
 
double getAperture ()
 Reads the current FStop value from the device.
 
double getAperture (long timeout_ms)
 Reads the current FStop value from the device.
 
long getApertureStepCount ()
 Returns the number of possible stops usable to change the opening of the aperture of the attached lens.
 
int getFocus ()
 Reads the current focus value from the device.
 
int getFocus (long timeout_ms)
 Reads the current focus value from the device.
 
double getMaxAperture ()
 Returns the maximum f-stop value of the attached lens.
 
int getMaxFocus ()
 Returns the maximum focus value of the attached lens.
 
double getMinAperture ()
 Returns the minimum f-stop value of the attached lens.
 
int getMinFocus ()
 Returns the minimum focus value of the attached lens.
 
String getSerial ()
 Returns the serial number of the connected adapter.
 
String getSerial (long timeout_ms)
 Returns the serial number of the connected adapter.
 
 LensControlBirger (Device pDev)
 Constructs a new mvIMPACT.acquire.labs.LensControlBirger object.
 
 LensControlBirger (Device pDev, long defaultCommunicationTimeout_ms)
 Constructs a new mvIMPACT.acquire.labs.LensControlBirger object.
 
double setAperture (int steps)
 Writes the new aperture to the device.
 
double setAperture (int steps, long timeout_ms)
 Writes the new aperture to the device.
 
double setApertureToMax ()
 Closes the aperture to the max possible value.
 
double setApertureToMax (long timeout_ms)
 Closes the aperture to the max possible value.
 
double setApertureToMin ()
 Opens the aperture to the min possible value.
 
double setApertureToMin (long timeout_ms)
 Opens the aperture to the min possible value.
 
int setFocus (int steps)
 Moves the focus about the provided number of encoder steps.
 
int setFocus (int steps, long timeout_ms)
 Moves the focus about the provided number of encoder steps.
 
int setFocusToInfinity ()
 Moves the focus to the infinity position.
 
int setFocusToInfinity (long timeout_ms)
 Moves the focus to the infinity position.
 
int setFocusToZero ()
 Moves the focus to the closest position.
 
int setFocusToZero (long timeout_ms)
 Moves the focus to the closest position.
 

Protected Member Functions

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

Static Protected Member Functions

static long swigRelease (LensControlBase obj)
 
static long swigRelease (LensControlBirger obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Contains convenience functions to control features understood by Birger Engineering, Inc.

lens adapters.

Attention
Please note that this class currently is part of the mvIMPACT.acquire.labs namespace! This means that this code is not yet final and therefore might change in a future release. Feedback will be highly appreciated and if changes are applied to this code a detailed migration guide can be found in the documentation!
Since
2.38.0

Constructor & Destructor Documentation

◆ LensControlBirger() [1/3]

LensControlBirger ( long cPtr,
boolean cMemoryOwn )
protected

◆ LensControlBirger() [2/3]

LensControlBirger ( Device pDev,
long defaultCommunicationTimeout_ms )

Constructs a new mvIMPACT.acquire.labs.LensControlBirger object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
defaultCommunicationTimeout_ms[in] The default timeout value in milliseconds after which a command is considered as not successful.

◆ LensControlBirger() [3/3]

LensControlBirger ( Device pDev)

Constructs a new mvIMPACT.acquire.labs.LensControlBirger object.

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

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from LensControlBase.

◆ finalize()

void finalize ( )
protected

Reimplemented from LensControlBase.

◆ getAperture() [1/2]

double getAperture ( )

Reads the current FStop value from the device.

Returns
The resulting f value the aperture is set to.

◆ getAperture() [2/2]

double getAperture ( long timeout_ms)

Reads the current FStop value from the device.

Returns
The resulting f value the aperture is set to.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ getApertureStepCount()

long getApertureStepCount ( )

Returns the number of possible stops usable to change the opening of the aperture of the attached lens.

Returns
The number of possible stops as unsigned int.

◆ getFocus() [1/2]

int getFocus ( )

Reads the current focus value from the device.

Returns
The value the focus is currently set to.

◆ getFocus() [2/2]

int getFocus ( long timeout_ms)

Reads the current focus value from the device.

Returns
The value the focus is currently set to.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ getMaxAperture()

double getMaxAperture ( )

Returns the maximum f-stop value of the attached lens.

Returns
The maximum f-stop value of the attached lens as double value.

◆ getMaxFocus()

int getMaxFocus ( )

Returns the maximum focus value of the attached lens.

Returns
The maximum focus value of the attached lens as unsigned int value.

◆ getMinAperture()

double getMinAperture ( )

Returns the minimum f-stop value of the attached lens.

Returns
The minimum f-stop value of the attached lens as double value.

◆ getMinFocus()

int getMinFocus ( )

Returns the minimum focus value of the attached lens.

Returns
The minimum focus value of the attached lens as unsigned int value.

◆ getSerial() [1/2]

String getSerial ( )

Returns the serial number of the connected adapter.

Returns
The serial number of the attached adapter as string.

◆ getSerial() [2/2]

String getSerial ( long timeout_ms)

Returns the serial number of the connected adapter.

Returns
The serial number of the attached adapter as string.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setAperture() [1/2]

double setAperture ( int steps)

Writes the new aperture to the device.

Returns
The resulting FStop value the aperture is set to.
Parameters
steps[in] The new aperture value which should be set in 1/4 stops.

◆ setAperture() [2/2]

double setAperture ( int steps,
long timeout_ms )

Writes the new aperture to the device.

Returns
The resulting FStop value the aperture is set to.
Parameters
steps[in] The new aperture value which should be set in 1/4 stops.
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setApertureToMax() [1/2]

double setApertureToMax ( )

Closes the aperture to the max possible value.

Returns
The number of steps (1/4 stops) the aperture has actually moved.

◆ setApertureToMax() [2/2]

double setApertureToMax ( long timeout_ms)

Closes the aperture to the max possible value.

Returns
The number of steps (1/4 stops) the aperture has actually moved.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setApertureToMin() [1/2]

double setApertureToMin ( )

Opens the aperture to the min possible value.

Returns
The number of steps (1/4 stops) the aperture has actually moved.

◆ setApertureToMin() [2/2]

double setApertureToMin ( long timeout_ms)

Opens the aperture to the min possible value.

Returns
The number of steps (1/4 stops) the aperture has actually moved.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocus() [1/2]

int setFocus ( int steps)

Moves the focus about the provided number of encoder steps.

Returns
The number of steps the focus has moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.
Parameters
steps[in] The value of encoder steps the focus should be moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.

◆ setFocus() [2/2]

int setFocus ( int steps,
long timeout_ms )

Moves the focus about the provided number of encoder steps.

Returns
The number of steps the focus has moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.
Parameters
steps[in] The value of encoder steps the focus should be moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocusToInfinity() [1/2]

int setFocusToInfinity ( )

Moves the focus to the infinity position.

Returns
The number of steps the focus has moved.

◆ setFocusToInfinity() [2/2]

int setFocusToInfinity ( long timeout_ms)

Moves the focus to the infinity position.

Returns
The number of steps the focus has moved.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocusToZero() [1/2]

int setFocusToZero ( )

Moves the focus to the closest position.

Returns
The number of steps the focus has moved.

◆ setFocusToZero() [2/2]

int setFocusToZero ( long timeout_ms)

Moves the focus to the closest position.

Returns
The number of steps the focus has moved.
Parameters
timeout_ms[in] The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ swigRelease() [1/2]

static long swigRelease ( LensControlBase obj)
staticprotectedinherited

◆ swigRelease() [2/2]

static long swigRelease ( LensControlBirger obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited