OpticControl Class Reference

Category for optical control features. More...

Public Member Functions
synchronized void	delete ()
PropertyF	getAperture ()
	A floating point property.
Method	getApertureInitialize ()
	A method object.
PropertyI64	getApertureStatus ()
	An enumerated integer property.
PropertyI64	getApertureStepper ()
	An integer property.
PropertyI64	getFilter ()
	An integer property.
Method	getFilterInitialize ()
	A method object.
PropertyI64	getFilterStatus ()
	An enumerated integer property.
PropertyF	getFocalLength ()
	A floating point property.
Method	getFocalLengthInitialize ()
	A method object.
PropertyI64	getFocalLengthStatus ()
	An enumerated integer property.
PropertyI64	getFocalLengthStepper ()
	An integer property.
PropertyF	getFocalPower ()
	A floating point property.
PropertyI64	getFocusAuto ()
	An enumerated integer property.
PropertyI64	getFocusAutoMode ()
	An enumerated integer property.
Method	getFocusInitialize ()
	A method object.
PropertyI64	getFocusStatus ()
	An enumerated integer property.
PropertyI64	getFocusStepper ()
	An integer property.
PropertyF	getMagnification ()
	A floating point property.
Method	getMagnificationInitialize ()
	A method object.
PropertyI64	getMagnificationStatus ()
	An enumerated integer property.
PropertyI64	getMagnificationStepper ()
	An integer property.
PropertyF	getNumericalAperture ()
	A floating point property.
PropertyF	getObjectSensorDistance ()
	A floating point property.
Method	getOpticControllerAbort ()
	A method object.
Method	getOpticControllerDisconnect ()
	A method object.
PropertyS	getOpticControllerFamilyName ()
	A string property.
PropertyS	getOpticControllerFirmwareVersion ()
	A string property.
Method	getOpticControllerInitialize ()
	A method object.
PropertyS	getOpticControllerModelName ()
	A string property.
PropertyI64	getOpticControllerSelector ()
	An enumerated integer property.
PropertyS	getOpticControllerSerialNumber ()
	A string property.
PropertyI64	getOpticControllerStatus ()
	An enumerated integer property.
PropertyF	getOpticControllerTemperature ()
	A floating point property.
PropertyS	getOpticControllerVendorName ()
	A string property.
PropertyS	getOpticControllerVersion ()
	A string property.
PropertyI64	getShutter ()
	An integer property.
Method	getShutterInitialize ()
	A method object.
PropertyI64	getShutterStatus ()
	An enumerated integer property.
PropertyI64	getStabilization ()
	An integer property.
Method	getStabilizationInitialize ()
	A method object.
PropertyI64	getStabilizationStatus ()
	An enumerated integer property.
	OpticControl (Device pDev)
	Constructs a new mvIMPACT.acquire.OpticControl object.
	OpticControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.OpticControl object.

Protected Member Functions
void	finalize ()
	OpticControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (OpticControl obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

Category for optical control features.

A category for optical control features.

Constructor & Destructor Documentation

OpticControl() [1/3]

OpticControl ( long cPtr, boolean cMemoryOwn )

protected

OpticControl() [2/3]

OpticControl	(	Device	pDev,
		String	settingName )

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

OpticControl() [3/3]

OpticControl

(

Device

pDev

)

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

(

)

finalize()

void finalize ( )

protected

getAperture()

PropertyF getAperture

(

)

A floating point property.

Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens.

Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens. The lower the f/# the more light goes through the lens (the 'faster' the lens) and the smaller the depth of field.

getApertureInitialize()

Method getApertureInitialize

(

)

A method object.

Initializes the aperture and makes it ready for use.

Initializes the aperture and makes it ready for use. The aperture position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getApertureStatus()

PropertyI64 getApertureStatus

(

)

An enumerated integer property.

Reads the status of the aperture.

Reads the status of the aperture.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The aperture controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The aperture controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The aperture controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The aperture controller executes a feature access/command.
• Ready (Display string: 'Ready'): The aperture controller is ready to use.
• Error (Display string: 'Error'): The aperture controller encountered an error.

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.

getApertureStepper()

PropertyI64 getApertureStepper

(

)

An integer property.

ApertureStepper controls the stepper value of the aperture.

ApertureStepper controls the stepper value of the aperture. 0 is the maximum opening.

getFilter()

PropertyI64 getFilter

(

)

An integer property.

Filter positions in native number system.

Filter positions in native number system. This is implementation dependent.

getFilterInitialize()

Method getFilterInitialize

(

)

A method object.

Initializes the filter and makes it ready for use.

Initializes the filter and makes it ready for use. The filter position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getFilterStatus()

PropertyI64 getFilterStatus

(

)

An enumerated integer property.

Reads the status of the filter.

Reads the status of the filter.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The filter controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The filter controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The filter controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The filter controller executes a feature access/command.
• Ready (Display string: 'Ready'): The filter controller is ready to use.
• Error (Display string: 'Error'): The filter controller encountered an error.

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.

getFocalLength()

PropertyF getFocalLength

(

)

A floating point property.

Focal length in millimeters (mm).

Focal length in millimeters (mm).

getFocalLengthInitialize()

Method getFocalLengthInitialize

(

)

A method object.

Initializes the focal length and makes it ready for use.

Initializes the focal length and makes it ready for use. The focal length position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getFocalLengthStatus()

PropertyI64 getFocalLengthStatus

(

)

An enumerated integer property.

Reads the status of the focal length.

Reads the status of the focal length.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The focal length controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The focal length controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The focal length controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The focal length controller executes a feature access/command.
• Ready (Display string: 'Ready'): The focal length controller is ready to use.
• Error (Display string: 'Error'): The focal length controller encountered an error.

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.

getFocalLengthStepper()

PropertyI64 getFocalLengthStepper

(

)

An integer property.

FocalLengthStepper controls the stepper value of the focal length.

FocalLengthStepper controls the stepper value of the focal length. 0 is the shortest focal length.

getFocalPower()

PropertyF getFocalPower

(

)

A floating point property.

Sets the focal power (in diopters/dpt).

Sets the focal power (in diopters/dpt). This is mostly used for liquid lenses and indicates how much a liquid lens focuses.

getFocusAuto()

PropertyI64 getFocusAuto

(

)

An enumerated integer property.

Sets automatic focus.

Sets automatic focus. If enabled, the optic device shall be set into a mode of operation, where the lens automatically finds the best possible focus.

The following string values might be valid for this feature:

• Off (Display string: 'Off'): The focus is set manually.
• Once (Display string: 'Once'): The focus is adapted once by the device. Once it has converged, it returns to the Off state.
• Continuous (Display string: 'Continuous'): The focus is constantly adapted by the device to maximize the dynamic range.

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.

getFocusAutoMode()

PropertyI64 getFocusAutoMode

(

)

An enumerated integer property.

Sets automatic focus mode.

Sets automatic focus mode.

The following string values might be valid for this feature:

• DistanceBased (Display string: 'Distance Based'): The OpticController has a built-in distance sensor and computes the focus based on the detected distance (open loop).
• ImageBased (Display string: 'Image Based'): The OpticController evaluates the image for closed loop control (closed loop).

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.

getFocusInitialize()

Method getFocusInitialize

(

)

A method object.

Initializes the focus and makes it ready for use.

Initializes the focus and makes it ready for use. The focus position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getFocusStatus()

PropertyI64 getFocusStatus

(

)

An enumerated integer property.

Reads the status of the focus.

Reads the status of the focus.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The focus controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The focus controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The focus controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The focus controller executes a feature access/command.
• Ready (Display string: 'Ready'): The focus controller is ready to use.
• Error (Display string: 'Error'): The focus controller encountered an error.

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.

getFocusStepper()

PropertyI64 getFocusStepper

(

)

An integer property.

FocusStepper controls the stepper value of the focus.

FocusStepper controls the stepper value of the focus. E.g. ObjectSensorDistance or FocalPower. 0 is the closest focus.

getMagnification()

PropertyF getMagnification

(

)

A floating point property.

Magnification of the lens, defined as ratio between apparent size of an image and its true size.

Magnification of the lens, defined as ratio between apparent size of an image and its true size.

getMagnificationInitialize()

Method getMagnificationInitialize

(

)

A method object.

Initializes the magnification and makes it ready for use.

Initializes the magnification and makes it ready for use. The magnification position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getMagnificationStatus()

PropertyI64 getMagnificationStatus

(

)

An enumerated integer property.

Reads the status of the magnification.

Reads the status of the magnification.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The magnification controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The magnification controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The magnification controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The magnification controller executes a feature access/command.
• Ready (Display string: 'Ready'): The magnification controller is ready to use.
• Error (Display string: 'Error'): The magnification controller encountered an error.

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.

getMagnificationStepper()

PropertyI64 getMagnificationStepper

(

)

An integer property.

MagnificationStepper controls the stepper value of the magnification.

MagnificationStepper controls the stepper value of the magnification. 0 is the lowest magnification.

getNumericalAperture()

PropertyF getNumericalAperture

(

)

A floating point property.

Sets the numerical aperture of a lens.

Sets the numerical aperture of a lens. It is inversely proportional to the f/#.

getObjectSensorDistance()

PropertyF getObjectSensorDistance

(

)

A floating point property.

Distance from the image sensor surface to the object in millimeters (mm).

Distance from the image sensor surface to the object in millimeters (mm).

getOpticControllerAbort()

Method getOpticControllerAbort

(

)

A method object.

Aborts the current command or feature access.

Aborts the current command or feature access. This will end the process without completing it or having reached the desired end position or value. If no command or feature access is in progress, the command is ignored.

getOpticControllerDisconnect()

Method getOpticControllerDisconnect

(

)

A method object.

Closes the optic controller connection and prepares it for removal.

Closes the optic controller connection and prepares it for removal.

getOpticControllerFamilyName()

PropertyS getOpticControllerFamilyName

(

)

A string property.

Name of the device family of the optic controller.

Name of the device family of the optic controller.

getOpticControllerFirmwareVersion()

PropertyS getOpticControllerFirmwareVersion

(

)

A string property.

Version of the firmware in the optic controller.

Version of the firmware in the optic controller.

getOpticControllerInitialize()

Method getOpticControllerInitialize

(

)

A method object.

Initializes the optic controller and makes it ready for use.

Initializes the optic controller and makes it ready for use.

getOpticControllerModelName()

PropertyS getOpticControllerModelName

(

)

A string property.

Model name of the optic controller.

Model name of the optic controller.

getOpticControllerSelector()

PropertyI64 getOpticControllerSelector

(

)

An enumerated integer property.

Selects which optic controller to configure.

Selects which optic controller to configure.

The following string values might be valid for this feature:

• OpticController0 (Display string: 'Optic Controller 0'): Selects Optic Controller 0.
• OpticController1 (Display string: 'Optic Controller 1'): Selects Optic Controller 1.
• OpticController2 (Display string: 'Optic Controller 2'): Selects Optic Controller 2.
• OpticController3 (Display string: 'Optic Controller 3'): Selects Optic Controller 3.
• OpticController4 (Display string: 'Optic Controller 4'): Selects Optic Controller 4.
• OpticController5 (Display string: 'Optic Controller 5'): Selects Optic Controller 5.
• OpticController6 (Display string: 'Optic Controller 6'): Selects Optic Controller 6.
• OpticController7 (Display string: 'Optic Controller 7'): Selects Optic Controller 7.
• OpticController8 (Display string: 'Optic Controller 8'): Selects Optic Controller 8.
• OpticController9 (Display string: 'Optic Controller 9'): Selects Optic Controller 9.
• OpticController10 (Display string: 'Optic Controller 10'): Selects Optic Controller 10.
• OpticController11 (Display string: 'Optic Controller 11'): Selects Optic Controller 11.
• OpticController12 (Display string: 'Optic Controller 12'): Selects Optic Controller 12.
• OpticController13 (Display string: 'Optic Controller 13'): Selects Optic Controller 13.
• OpticController14 (Display string: 'Optic Controller 14'): Selects Optic Controller 14.
• OpticController15 (Display string: 'Optic Controller 15'): Selects Optic Controller 15.

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.

getOpticControllerSerialNumber()

PropertyS getOpticControllerSerialNumber

(

)

A string property.

Serial number of the optic controller.

Serial number of the optic controller.

getOpticControllerStatus()

PropertyI64 getOpticControllerStatus

(

)

An enumerated integer property.

Reads the status of the optic controller.

Reads the status of the optic controller.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The optic controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The optic controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The optic controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The optic controller executes a feature access/command.
• Ready (Display string: 'Ready'): The optic controller is ready to use.
• Error (Display string: 'Error'): The optic controller encountered an error.

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.

getOpticControllerTemperature()

PropertyF getOpticControllerTemperature

(

)

A floating point property.

Temperature of the optic controller in degrees Celsius (C).

Temperature of the optic controller in degrees Celsius (C).

getOpticControllerVendorName()

PropertyS getOpticControllerVendorName

(

)

A string property.

Name of the manufacturer of the optic controller.

Name of the manufacturer of the optic controller.

getOpticControllerVersion()

PropertyS getOpticControllerVersion

(

)

A string property.

Version of the optic controller.

Version of the optic controller.

getShutter()

PropertyI64 getShutter

(

)

An integer property.

Controls whether the shutter is opened or closed.

Controls whether the shutter is opened or closed.

getShutterInitialize()

Method getShutterInitialize

(

)

A method object.

Initializes the shutter and makes it ready for use.

Initializes the shutter and makes it ready for use. The shutter position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getShutterStatus()

PropertyI64 getShutterStatus

(

)

An enumerated integer property.

Reads the status of the shutter.

Reads the status of the shutter.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The shutter controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The shutter controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The shutter controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The shutter controller executes a feature access/command.
• Ready (Display string: 'Ready'): The shutter controller is ready to use.
• Error (Display string: 'Error'): The shutter controller encountered an error.

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.

getStabilization()

PropertyI64 getStabilization

(

)

An integer property.

Control of image stabilization function build into the optic controller.

Control of image stabilization function build into the optic controller.

getStabilizationInitialize()

Method getStabilizationInitialize

(

)

A method object.

Initializes the stabilization and makes it ready for use.

Initializes the stabilization and makes it ready for use. The stabilization state after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

getStabilizationStatus()

PropertyI64 getStabilizationStatus

(

)

An enumerated integer property.

Reads the status of the stabilization.

Reads the status of the stabilization.

The following string values might be valid for this feature:

• NotConnected (Display string: 'Not Connected'): The stabilization controller is physically not connected.
• NotInitialized (Display string: 'Not Initialized'): The stabilization controller is not initialized.
• NotSupported (Display string: 'Not Supported'): The stabilization controller is physically connected but not supported.
• Busy (Display string: 'Busy'): The stabilization controller executes a feature access/command.
• Ready (Display string: 'Ready'): The stabilization controller is ready to use.
• Error (Display string: 'Error'): The stabilization controller encountered an error.

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.

swigRelease()

static long swigRelease ( OpticControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected