Impact Acquire SDK Java
Loading...
Searching...
No Matches
mvPoDLDeviceControl Class Reference

Category for device information and control. More...

Inheritance diagram for mvPoDLDeviceControl:
[legend]

Public Member Functions

synchronized void delete ()
PropertyS getMvPoDLDeviceFamilyName ()
 A string property.
PropertyS getMvPoDLDeviceFirmwareId ()
 A string property.
PropertyS getMvPoDLDeviceFirmwareVersion ()
 A string property.
PropertyS getMvPoDLDeviceManufacturerInfo ()
 A string property.
PropertyS getMvPoDLDeviceModelName ()
 A string property.
PropertyI64 getMvPoDLDeviceRegistersEndianness ()
 An enumerated integer property.
Method getMvPoDLDeviceReset ()
 A method object.
PropertyS getMvPoDLDeviceSerialNumber ()
 A string property.
PropertyF getMvPoDLDeviceTemperature ()
 A floating point property.
PropertyI64 getMvPoDLDeviceTemperatureSelector ()
 An enumerated integer property.
PropertyS getMvPoDLDeviceUserID ()
 A string property.
PropertyS getMvPoDLDeviceVendorName ()
 A string property.
PropertyS getMvPoDLDeviceVersion ()
 A string property.
Method getMvPoDLFirmwareUpdateMode ()
 A method object.
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 mvPoDLDeviceControl (Device pDev)
 Constructs a new mvIMPACT.acquire.mvPoDLDeviceControl object.
 mvPoDLDeviceControl (Device pDev, String settingName)
 Constructs a new mvIMPACT.acquire.mvPoDLDeviceControl object.
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.

Protected Member Functions

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

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
static long swigRelease (mvPoDLDeviceControl obj)

Protected Attributes

transient boolean swigCMemOwn

Detailed Description

Category for device information and control.

Category for device information and control.

Constructor & Destructor Documentation

◆ mvPoDLDeviceControl() [1/3]

mvPoDLDeviceControl ( long cPtr,
boolean cMemoryOwn )
protected

◆ mvPoDLDeviceControl() [2/3]

mvPoDLDeviceControl ( Device pDev,
String settingName )

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

◆ mvPoDLDeviceControl() [3/3]

mvPoDLDeviceControl ( Device pDev)

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

◆ getMvPoDLDeviceFamilyName()

PropertyS getMvPoDLDeviceFamilyName ( )

A string property.

Identifier of the product family of the device.

Identifier of the product family of the device.

◆ getMvPoDLDeviceFirmwareId()

PropertyS getMvPoDLDeviceFirmwareId ( )

A string property.

Identifier of the firmware in the device.

Identifier of the firmware in the device.

◆ getMvPoDLDeviceFirmwareVersion()

PropertyS getMvPoDLDeviceFirmwareVersion ( )

A string property.

Version of the firmware in the device.

Version of the firmware in the device.

◆ getMvPoDLDeviceManufacturerInfo()

PropertyS getMvPoDLDeviceManufacturerInfo ( )

A string property.

Manufacturer information about the device.

Manufacturer information about the device.

◆ getMvPoDLDeviceModelName()

PropertyS getMvPoDLDeviceModelName ( )

A string property.

Model of the device.

Model of the device.

◆ getMvPoDLDeviceRegistersEndianness()

PropertyI64 getMvPoDLDeviceRegistersEndianness ( )

An enumerated integer property.

Endianness of the registers of the device.

Endianness of the registers of the device.

The following string values might be valid for this feature:

  • Big (Display string: 'Big'): Device's registers are big Endian.
  • Little (Display string: 'Little'): Device's registers are little Endian.
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.

◆ getMvPoDLDeviceReset()

Method getMvPoDLDeviceReset ( )

A method object.

Resets the device to its power up state.

Resets the device to its power up state. After reset, the device must be rediscovered.

◆ getMvPoDLDeviceSerialNumber()

PropertyS getMvPoDLDeviceSerialNumber ( )

A string property.

Device's serial number.

Device's serial number. This string is a unique identifier of the device.

◆ getMvPoDLDeviceTemperature()

PropertyF getMvPoDLDeviceTemperature ( )

A floating point property.

Device temperature in degrees Celsius (C).

Device temperature in degrees Celsius (C). It is measured at the location selected by DeviceTemperatureSelector.

◆ getMvPoDLDeviceTemperatureSelector()

PropertyI64 getMvPoDLDeviceTemperatureSelector ( )

An enumerated integer property.

Selects the location within the device, where the temperature will be measured.

Selects the location within the device, where the temperature will be measured.

The following string values might be valid for this feature:

  • Mainboard (Display string: 'Mainboard'): Temperature of the device's mainboard.
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.

◆ getMvPoDLDeviceUserID()

PropertyS getMvPoDLDeviceUserID ( )

A string property.

User-programmable device identifier.

User-programmable device identifier.

◆ getMvPoDLDeviceVendorName()

PropertyS getMvPoDLDeviceVendorName ( )

A string property.

Name of the manufacturer of the device.

Name of the manufacturer of the device.

◆ getMvPoDLDeviceVersion()

PropertyS getMvPoDLDeviceVersion ( )

A string property.

Version of the device.

Version of the device.

◆ getMvPoDLFirmwareUpdateMode()

Method getMvPoDLFirmwareUpdateMode ( )

A method object.

Resets the camera to the firmware update mode

Resets the camera to the firmware update mode

◆ 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]

long swigRelease ( ComponentCollection obj)
staticprotectedinherited

◆ swigRelease() [2/2]

long swigRelease ( mvPoDLDeviceControl obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited