Impact Acquire SDK Java
Info Class Reference

A base class to access various general information about the device and its driver. More...

Inheritance diagram for Info:
[legend]

Public Member Functions

synchronized void delete ()
 
PropertyI getCaptureBufferAlignment ()
 An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.
 
PropertyS getDeviceDriverVersion ()
 An integer property (read-only) containing the device driver version used by this device.
 
PropertyS getDriverDate ()
 A string property (read-only) containing the date the device driver has been compiled.
 
PropertyS getDriverVersion ()
 A string property (read-only) containing the version number of the device driver.
 
PropertyS getLoadedSettings ()
 A string property (read-only) containing the name of the setting currently loaded.
 
PropertyS getLogFile ()
 A string property (read-only) containing the name and the full path of the current log-file for this device.
 
PropertyS getRecommendedListsForUIs ()
 A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.
 
PropertyI getState ()
 An enumerated integer property (read-only) containing the current state of this device.
 
PropertyI getSystemLogicalProcessorCount ()
 An integer property (read-only) containing the number of logical processors detected in the current system.
 
PropertyI getSystemPhysicalProcessorCount ()
 An integer property (read-only) containing the number of physical processors detected in the current system.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
 Info (Device pDev)
 Constructs a new mvIMPACT.acquire.Info object.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 

Protected Member Functions

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

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
 
static long swigRelease (Info obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A base class to access various general information about the device and its driver.

This class contains a collection of properties providing various information about the device and its driver.

Instances of this class can't be constructed directly. Use one of the derived types.

Constructor & Destructor Documentation

◆ Info() [1/2]

Info ( long cPtr,
boolean cMemoryOwn )
protected

◆ Info() [2/2]

Info ( Device pDev)

Constructs a new mvIMPACT.acquire.Info object.

Parameters
pDevA pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

Reimplemented in InfoBlueCOUGAR, InfoBlueDevice, and InfoBlueFOX.

◆ finalize()

void finalize ( )
protected

Reimplemented from ComponentCollection.

Reimplemented in InfoBlueCOUGAR, InfoBlueDevice, and InfoBlueFOX.

◆ getCaptureBufferAlignment()

PropertyI getCaptureBufferAlignment ( )

An integer property (read-only) containing the capture buffer alignment in bytes needed by this device driver.

◆ getDeviceDriverVersion()

PropertyS getDeviceDriverVersion ( )

An integer property (read-only) containing the device driver version used by this device.

This is the version of the underlying hardware driver. For device drivers that don't have another user mode driver below the interface driver this property will contain the same version information as the property mvIMPACT.acquire.Info.getDriverVersion().

◆ getDriverDate()

PropertyS getDriverDate ( )

A string property (read-only) containing the date the device driver has been compiled.

◆ getDriverVersion()

PropertyS getDriverVersion ( )

A string property (read-only) containing the version number of the device driver.

◆ getLoadedSettings()

PropertyS getLoadedSettings ( )

A string property (read-only) containing the name of the setting currently loaded.

◆ getLogFile()

PropertyS getLogFile ( )

A string property (read-only) containing the name and the full path of the current log-file for this device.

◆ getRecommendedListsForUIs()

PropertyS getRecommendedListsForUIs ( )

A string property (read-only) containing an array of full search paths to lists which are recommended to be displayed in a user interface that is created dynamically.

◆ getState()

PropertyI getState ( )

An enumerated integer property (read-only) containing the current state of this device.

This property e.g. provides information about the current state of the device. For USB devices this can e.g. indicate whether a device is currently plugged into the system or not.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDeviceState.

GenICam/GenTL device specific: In order to reduce the amount of network traffic to a minimum, this property will only be updated automatically for network devices if the property mvIMPACT.acquire.Device.registerErrorEvent is set to mvIMPACT.acquire.TBoolean.bTrue (which is the default behaviour). If the IP addresses stay the same the connection is automatically re-established then once the device is detected by the driver again. However if the IP address of the device and/or the network adapter of the system it is used from changes mvIMPACT.acquire.DeviceManager.updateDeviceList() must be called regardless of the value of mvIMPACT.acquire.Device.registerErrorEvent before a device that was lost can re-establish a connection to the capture driver.

◆ getSystemLogicalProcessorCount()

PropertyI getSystemLogicalProcessorCount ( )

An integer property (read-only) containing the number of logical processors detected in the current system.

Since
2.44.0

◆ getSystemPhysicalProcessorCount()

PropertyI getSystemPhysicalProcessorCount ( )

An integer property (read-only) containing the number of physical processors detected in the current system.

Since
2.44.0

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

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited