Impact Acquire SDK .NET
Public Member Functions | Public Attributes | List of all members
OpticControl Class Reference
GenICam Interface Layout » GenICam Interface Layout (Device)

Category for optical control features. More...

Public Member Functions

 OpticControl (mv.impact.acquire.Device device)
 Constructs a new mv.impact.acquire.GenICam.OpticControl object.
 
 OpticControl (mv.impact.acquire.Device device, System.String settingName)
 Constructs a new mv.impact.acquire.GenICam.OpticControl object.
 

Public Attributes

readonly mv.impact.acquire.PropertyF aperture = new mv.impact.acquire.PropertyF()
 A floating point property. Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens.
 
readonly mv.impact.acquire.Method apertureInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the aperture and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 apertureStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the aperture.
 
readonly mv.impact.acquire.PropertyI64 apertureStepper = new mv.impact.acquire.PropertyI64()
 An integer property. ApertureStepper controls the stepper value of the aperture.
 
readonly mv.impact.acquire.PropertyI64 filter = new mv.impact.acquire.PropertyI64()
 An integer property. Filter positions in native number system.
 
readonly mv.impact.acquire.Method filterInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the filter and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 filterStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the filter.
 
readonly mv.impact.acquire.PropertyF focalLength = new mv.impact.acquire.PropertyF()
 A floating point property. Focal length in millimeters (mm).
 
readonly mv.impact.acquire.Method focalLengthInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the focal length and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 focalLengthStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the focal length.
 
readonly mv.impact.acquire.PropertyI64 focalLengthStepper = new mv.impact.acquire.PropertyI64()
 An integer property. FocalLengthStepper controls the stepper value of the focal length.
 
readonly mv.impact.acquire.PropertyF focalPower = new mv.impact.acquire.PropertyF()
 A floating point property. Sets the focal power (in diopters/dpt).
 
readonly mv.impact.acquire.PropertyI64 focusAuto = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Sets automatic focus.
 
readonly mv.impact.acquire.PropertyI64 focusAutoMode = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Sets automatic focus mode.
 
readonly mv.impact.acquire.Method focusInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the focus and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 focusStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the focus.
 
readonly mv.impact.acquire.PropertyI64 focusStepper = new mv.impact.acquire.PropertyI64()
 An integer property. FocusStepper controls the stepper value of the focus.
 
readonly mv.impact.acquire.PropertyF magnification = new mv.impact.acquire.PropertyF()
 A floating point property. Magnification of the lens, defined as ratio between apparent size of an image and its true size.
 
readonly mv.impact.acquire.Method magnificationInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the magnification and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 magnificationStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the magnification.
 
readonly mv.impact.acquire.PropertyI64 magnificationStepper = new mv.impact.acquire.PropertyI64()
 An integer property. MagnificationStepper controls the stepper value of the magnification.
 
readonly mv.impact.acquire.PropertyF numericalAperture = new mv.impact.acquire.PropertyF()
 A floating point property. Sets the numerical aperture of a lens.
 
readonly mv.impact.acquire.PropertyF objectSensorDistance = new mv.impact.acquire.PropertyF()
 A floating point property. Distance from the image sensor surface to the object in millimeters (mm).
 
readonly mv.impact.acquire.Method opticControllerAbort = new mv.impact.acquire.Method()
 A method object. Aborts the current command or feature access.
 
readonly mv.impact.acquire.Method opticControllerDisconnect = new mv.impact.acquire.Method()
 A method object. Closes the optic controller connection and prepares it for removal.
 
readonly mv.impact.acquire.PropertyS opticControllerFamilyName = new mv.impact.acquire.PropertyS()
 A string property. Name of the device family of the optic controller.
 
readonly mv.impact.acquire.PropertyS opticControllerFirmwareVersion = new mv.impact.acquire.PropertyS()
 A string property. Version of the firmware in the optic controller.
 
readonly mv.impact.acquire.Method opticControllerInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the optic controller and makes it ready for use.
 
readonly mv.impact.acquire.PropertyS opticControllerModelName = new mv.impact.acquire.PropertyS()
 A string property. Model name of the optic controller.
 
readonly mv.impact.acquire.PropertyI64 opticControllerSelector = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Selects which optic controller to configure.
 
readonly mv.impact.acquire.PropertyS opticControllerSerialNumber = new mv.impact.acquire.PropertyS()
 A string property. Serial number of the optic controller.
 
readonly mv.impact.acquire.PropertyI64 opticControllerStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the optic controller.
 
readonly mv.impact.acquire.PropertyF opticControllerTemperature = new mv.impact.acquire.PropertyF()
 A floating point property. Temperature of the optic controller in degrees Celsius (C).
 
readonly mv.impact.acquire.PropertyS opticControllerVendorName = new mv.impact.acquire.PropertyS()
 A string property. Name of the manufacturer of the optic controller.
 
readonly mv.impact.acquire.PropertyS opticControllerVersion = new mv.impact.acquire.PropertyS()
 A string property. Version of the optic controller.
 
readonly mv.impact.acquire.PropertyI64 shutter = new mv.impact.acquire.PropertyI64()
 An integer property. Controls whether the shutter is opened or closed.
 
readonly mv.impact.acquire.Method shutterInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the shutter and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 shutterStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the shutter.
 
readonly mv.impact.acquire.PropertyI64 stabilization = new mv.impact.acquire.PropertyI64()
 An integer property. Control of image stabilization function build into the optic controller.
 
readonly mv.impact.acquire.Method stabilizationInitialize = new mv.impact.acquire.Method()
 A method object. Initializes the stabilization and makes it ready for use.
 
readonly mv.impact.acquire.PropertyI64 stabilizationStatus = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. Reads the status of the stabilization.
 

Detailed Description

Category for optical control features.

A category for optical control features.

Constructor & Destructor Documentation

◆ OpticControl() [1/2]

OpticControl ( mv::impact::acquire::Device device)
inline

Constructs a new mv.impact.acquire.GenICam.OpticControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ OpticControl() [2/2]

OpticControl ( mv::impact::acquire::Device device,
System::String settingName )
inline

Constructs a new mv.impact.acquire.GenICam.OpticControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Data Documentation

◆ aperture

readonly mv.impact.acquire.PropertyF aperture = new mv.impact.acquire.PropertyF()

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.

◆ apertureInitialize

readonly mv.impact.acquire.Method apertureInitialize = new mv.impact.acquire.Method()

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.

◆ apertureStatus

readonly mv.impact.acquire.PropertyI64 apertureStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ apertureStepper

readonly mv.impact.acquire.PropertyI64 apertureStepper = new mv.impact.acquire.PropertyI64()

An integer property. ApertureStepper controls the stepper value of the aperture.

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

◆ filter

readonly mv.impact.acquire.PropertyI64 filter = new mv.impact.acquire.PropertyI64()

An integer property. Filter positions in native number system.

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

◆ filterInitialize

readonly mv.impact.acquire.Method filterInitialize = new mv.impact.acquire.Method()

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.

◆ filterStatus

readonly mv.impact.acquire.PropertyI64 filterStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focalLength

readonly mv.impact.acquire.PropertyF focalLength = new mv.impact.acquire.PropertyF()

A floating point property. Focal length in millimeters (mm).

Focal length in millimeters (mm).

◆ focalLengthInitialize

readonly mv.impact.acquire.Method focalLengthInitialize = new mv.impact.acquire.Method()

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.

◆ focalLengthStatus

readonly mv.impact.acquire.PropertyI64 focalLengthStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focalLengthStepper

readonly mv.impact.acquire.PropertyI64 focalLengthStepper = new mv.impact.acquire.PropertyI64()

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.

◆ focalPower

readonly mv.impact.acquire.PropertyF focalPower = new mv.impact.acquire.PropertyF()

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.

◆ focusAuto

readonly mv.impact.acquire.PropertyI64 focusAuto = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusAutoMode

readonly mv.impact.acquire.PropertyI64 focusAutoMode = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusInitialize

readonly mv.impact.acquire.Method focusInitialize = new mv.impact.acquire.Method()

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.

◆ focusStatus

readonly mv.impact.acquire.PropertyI64 focusStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusStepper

readonly mv.impact.acquire.PropertyI64 focusStepper = new mv.impact.acquire.PropertyI64()

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.

◆ magnification

readonly mv.impact.acquire.PropertyF magnification = new mv.impact.acquire.PropertyF()

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.

◆ magnificationInitialize

readonly mv.impact.acquire.Method magnificationInitialize = new mv.impact.acquire.Method()

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.

◆ magnificationStatus

readonly mv.impact.acquire.PropertyI64 magnificationStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ magnificationStepper

readonly mv.impact.acquire.PropertyI64 magnificationStepper = new mv.impact.acquire.PropertyI64()

An integer property. MagnificationStepper controls the stepper value of the magnification.

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

◆ numericalAperture

readonly mv.impact.acquire.PropertyF numericalAperture = new mv.impact.acquire.PropertyF()

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/#.

◆ objectSensorDistance

readonly mv.impact.acquire.PropertyF objectSensorDistance = new mv.impact.acquire.PropertyF()

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).

◆ opticControllerAbort

readonly mv.impact.acquire.Method opticControllerAbort = new mv.impact.acquire.Method()

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.

◆ opticControllerDisconnect

readonly mv.impact.acquire.Method opticControllerDisconnect = new mv.impact.acquire.Method()

A method object. Closes the optic controller connection and prepares it for removal.

Closes the optic controller connection and prepares it for removal.

◆ opticControllerFamilyName

readonly mv.impact.acquire.PropertyS opticControllerFamilyName = new mv.impact.acquire.PropertyS()

A string property. Name of the device family of the optic controller.

Name of the device family of the optic controller.

◆ opticControllerFirmwareVersion

readonly mv.impact.acquire.PropertyS opticControllerFirmwareVersion = new mv.impact.acquire.PropertyS()

A string property. Version of the firmware in the optic controller.

Version of the firmware in the optic controller.

◆ opticControllerInitialize

readonly mv.impact.acquire.Method opticControllerInitialize = new mv.impact.acquire.Method()

A method object. Initializes the optic controller and makes it ready for use.

Initializes the optic controller and makes it ready for use.

◆ opticControllerModelName

readonly mv.impact.acquire.PropertyS opticControllerModelName = new mv.impact.acquire.PropertyS()

A string property. Model name of the optic controller.

Model name of the optic controller.

◆ opticControllerSelector

readonly mv.impact.acquire.PropertyI64 opticControllerSelector = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ opticControllerSerialNumber

readonly mv.impact.acquire.PropertyS opticControllerSerialNumber = new mv.impact.acquire.PropertyS()

A string property. Serial number of the optic controller.

Serial number of the optic controller.

◆ opticControllerStatus

readonly mv.impact.acquire.PropertyI64 opticControllerStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ opticControllerTemperature

readonly mv.impact.acquire.PropertyF opticControllerTemperature = new mv.impact.acquire.PropertyF()

A floating point property. Temperature of the optic controller in degrees Celsius (C).

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

◆ opticControllerVendorName

readonly mv.impact.acquire.PropertyS opticControllerVendorName = new mv.impact.acquire.PropertyS()

A string property. Name of the manufacturer of the optic controller.

Name of the manufacturer of the optic controller.

◆ opticControllerVersion

readonly mv.impact.acquire.PropertyS opticControllerVersion = new mv.impact.acquire.PropertyS()

A string property. Version of the optic controller.

Version of the optic controller.

◆ shutter

readonly mv.impact.acquire.PropertyI64 shutter = new mv.impact.acquire.PropertyI64()

An integer property. Controls whether the shutter is opened or closed.

Controls whether the shutter is opened or closed.

◆ shutterInitialize

readonly mv.impact.acquire.Method shutterInitialize = new mv.impact.acquire.Method()

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.

◆ shutterStatus

readonly mv.impact.acquire.PropertyI64 shutterStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ stabilization

readonly mv.impact.acquire.PropertyI64 stabilization = new mv.impact.acquire.PropertyI64()

An integer property. Control of image stabilization function build into the optic controller.

Control of image stabilization function build into the optic controller.

◆ stabilizationInitialize

readonly mv.impact.acquire.Method stabilizationInitialize = new mv.impact.acquire.Method()

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.

◆ stabilizationStatus

readonly mv.impact.acquire.PropertyI64 stabilizationStatus = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.