This class and its functions represent an actual device detected by this interface in the current system. More...

Public Member Functions
void	close ()
	Closes an opened device.

synchronized void	delete ()

	Device (Device src)
	Copy constructor.

ComponentList	deviceDriverFeatureList ()
	Returns a list providing access to driver library specific features.

PropertyI	getAcquisitionStartStopBehaviour ()
	An enumerated integer property defining the start/stop behaviour during acquisition of this driver instance.

PropertyI	getAllowUnrecommendedFeatures ()
	An enumerated integer property which can be used to unlock certain features, that are available but not recommended by the device manufacturer.

PropertyS	getAutoLoadSettingOrder ()
	A string property (read-only) containing the auto load order of feature settings that is executed during initialisation of the device.

PropertyI	getAutoNegotiatePacketSize ()
	An enumerated integer property which can be used to enable or disable the MTU auto negotiation of a GigE Vision device when opening it.

PropertyI	getAutoNegotiatePacketSizeMode ()
	An enumerated integer property (read-only) that can be used to define how the auto packet size negotiation for a GigE Vision device is handled.

PropertyI	getCapabilities ()
	An enumerated integer property (read-only) defining special device capabilities.

PropertyS	getCustomDataDirectory ()
	A string property (read-only once the device is open) containing a path to a custom directory for the location of camera description files, etc.

PropertyI	getDefaultRequestCount ()
	An integer property that defines the number of mvIMPACT.acquire.Request objects to be created when the device is opened.

PropertyI	getDesiredAccess ()
	An enumerated integer property that can be used to define the desired access to the device when opening it.

PropertyI	getDeviceClass ()
	An enumerated integer property (read-only) defining the device class this device belongs to.

PropertyS	getDeviceFamilyName ()
	A string property (read-only) containing the family name of this device.

PropertyI	getDeviceID ()
	An integer property (read-only) containing the device ID associated with this device.

PropertyS	getDeviceModelName ()
	A string property (read-only) containing the model name of this device.

PropertyS	getDeviceVersion ()
	A string property (read-only) containing the version(e.g.

PropertyS	getFamily ()
	A string property (read-only) containing the family name of this device.

PropertyI	getFirmwareVersion ()
	An integer property (read-only) containing the firmware version of this device.

PropertyI	getGrantedAccess ()
	An enumerated integer property (read-only) that can be used to query the granted access to the device after an attempt to open it.

PropertyI	getHWUpdateResult ()
	An enumerated integer property (read-only) defining user executed hardware update results.

PropertyI	getInterfaceLayout ()
	An enumerated integer property which can be used to define which interface layout shall be used when the device is opened.

PropertyS	getLicenseDetails ()
	A string property (read-only) that indicates why a device may be used with this SDK.

PropertyI	getLicenseValid ()
	A boolean property (read-only) that indicates if a device may be used with this SDK.

PropertyI	getLoadSettings ()
	An enumerated integer property which can be used to define which previously stored setting to load when the device is opened.

PropertyS	getManufacturer ()
	A string property (read-only) containing the name of the manufacturer of this device.

PropertyS	getManufacturerSpecificInformation ()
	A string property (read-only) containing manufacturer specific information of this device.

PropertyS	getProduct ()
	A string property (read-only) containing the product name of this device.

PropertyI	getResultQueueCount ()
	An integer property that defines the number of result queues to be created when the device is opened.

PropertyS	getSerial ()
	A string property (read-only) containing the serial number of this device.

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

PropertyI	getStreamChannelCount ()
	An integer property providing the number of stream channels supported by this device.

PropertyI	getUserControlledImageProcessingEnable ()
	An enumerated integer property defining whether user controlled image processing related features shall be created under 'System Settings' or not.

UserData	getUserData ()
	Returns a reference to a helper class to handle user specific data stored in the devices non-volatile memory(if available).

boolean	hasCapability (int capability)
	Checks whether this device has a certain capability.

boolean	hasValidLicense ()
	Checks whether this device has a valid usage license.

int	hDev ()
	A unique identifier for this device.

int	hDrv ()
	A unique identifier for the functionality offered by this device.

boolean	isInUse ()
	Returns the current usage status of this device.

boolean	isOpen ()
	Returns the current initialisation status in this process.

void	open ()
	Opens a device.

int	setID (int newID)
	Assigns a new ID to this device.

int	updateFirmware ()
	Updates the firmware of the device.

void	validateInterfaceLayout (int requiredInterfaceLayout)
	A convenience function mostly used internally.

Protected Member Functions
	Device (long cPtr, boolean cMemoryOwn)

void	finalize ()

Static Protected Member Functions
static long	swigRelease (Device obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

This class and its functions represent an actual device detected by this interface in the current system.

Instances of it can only be created by instances of the mvIMPACT.acquire.DeviceManager class as only the mvIMPACT.acquire.DeviceManager has the precise knowledge to do that anyway. As a result from this fact pointers to instances of mvIMPACT.acquire.Device can be obtained via a mvIMPACT.acquire.DeviceManager object only.

Attention: NEVER try to explicitly delete an instance of mvIMPACT.acquire.Device! You did not allocate it and the result will be a crash! The mvIMPACT.acquire.DeviceManager will take care of all resources for you.

A valid pointer to a mvIMPACT.acquire.Device object is needed to construct most of the other objects available in this interface.

Almost every object requiring a valid pointer to a mvIMPACT.acquire.Device object will need to device in an initialized state as the properties provided e.g. by the class mvIMPACT.acquire.CameraSettingsBase will be constructed when the device is initialized. To initialize a device this class provides the function mvIMPACT.acquire.Device.open. However every object which needs an initialized device to be constructed successfully will try to open the device when it hasn't been opened before, so the user does not need to call this function explicitly.

Attention: Whenever a device is closed via a call to mvIMPACT.acquire.Device.close all other objects constructed with a pointer to that device(e.g. mvIMPACT.acquire.CameraSettingsBase before will become invalid and need to be reconstructed afterwards, so don't close a device needlessly.; Whenever the last instance to a DeviceManager object gets destroyed within the current process every remaining device that was opened in this process before will be closed automatically! Thus every instance to mvIMPACT.acquire.Device objects or objects created with a pointer to a mvIMPACT.acquire.Device object will become invalid automatically. Therefore the user has to make sure there is always at least one instance to a mvIMPACT.acquire.DeviceManager object within the current process unless no more device access functions shall be called!

Constructor & Destructor Documentation

◆ Device() [1/2]

Device	(	long	cPtr,
		boolean	cMemoryOwn )

protected

◆ Device() [2/2]

Device ( Device src )

Copy constructor.

Creates a new object from an existing device object. Keep in mind that this new object will provide access to the very same hardware and therefore you might as well use the original reference returned from the mvIMPACT.acquire.DeviceManager. This constructor is only provided for internal reference counting to guarantee correct operation of the objects of this class under all platforms and languages.

Member Function Documentation

◆ close()

void close ( )

Closes an opened device.

This function closes a device previously opened again.

Attention: Whenever a device is closed via a call to mvIMPACT.acquire.Device.close all other objects constructed with a pointer to that device(e.g. mvIMPACT.acquire.CameraSettingsBase before will become invalid and need to be reconstructed afterwards, so don't close a device needlessly.

See also: Device.open,
Device.isOpen

◆ delete()

synchronized void delete ( )

◆ deviceDriverFeatureList()

ComponentList deviceDriverFeatureList ( )

Returns a list providing access to driver library specific features.

This list does exist only once per device driver library. Changes in this list will affect all devices that are operated using this device driver library.

Since: 2.17.0

◆ finalize()

void finalize ( )

protected

◆ getAcquisitionStartStopBehaviour()

PropertyI getAcquisitionStartStopBehaviour ( )

An enumerated integer property defining the start/stop behaviour during acquisition of this driver instance.

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

Note: This property will become read-only while the device is open.; This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

Not every device will offer the same options. Check for valid modes by reading the properties translation dictionary with the functions mvIMPACT.acquire.PropertyIAcquisitionStartStopBehaviour.getTranslationDictString and mvIMPACT.acquire.PropertyIAcquisitionStartStopBehaviour.getTranslationDictValue.

Since: 1.12.11

◆ getAllowUnrecommendedFeatures()

PropertyI getAllowUnrecommendedFeatures ( )

An enumerated integer property which can be used to unlock certain features, that are available but not recommended by the device manufacturer.

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

This property will be invisible by default. As the name indicates its use requires special knowledge that can be provided by the device manufacturer on request.

Note: Once the device is in use (has been initialized) this property will become (read-only).

Attention: Unlocking certain unrecommended features might result in the appearance of new translation dictionary entries for certain properties. Some of these translation strings might contain an exclamation mark ('!') in its name. NEVER rely on that! These exclamation marks or even the complete entry might disappear with a new driver release without further notice!

◆ getAutoLoadSettingOrder()

PropertyS getAutoLoadSettingOrder ( )

A string property (read-only) containing the auto load order of feature settings that is executed during initialisation of the device.

The first setting detected on the system will be used.

◆ getAutoNegotiatePacketSize()

PropertyI getAutoNegotiatePacketSize ( )

An enumerated integer property which can be used to enable or disable the MTU auto negotiation of a GigE Vision device when opening it.

If set to true, the driver will try to determine the max. possible packet size during init, which if successful will result in optimal performance. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note: Once the device is in use (has been initialized) this property will become (read-only). If this feature is disabled even before the device has been opened a firmware update is needed to use it when accessed via the mvGenTLProducer-lib. When using a 3rd party GenTL producer to access the GigE Vision device this feature will not be available.; This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getAutoNegotiatePacketSizeMode()

PropertyI getAutoNegotiatePacketSizeMode ( )

An enumerated integer property (read-only) that can be used to define how the auto packet size negotiation for a GigE Vision device is handled.

If set to mvIMPACT.acquire.TDeviceAutoNegotiatePacketSizeMode.danpsmHighToLow the MTU is automatically negotiated starting from the NICs current MTU down to a value supported by all components belonging to the network path (device, network interface card, switches, ...), if set to mvIMPACT.acquire.TDeviceAutoNegotiatePacketSizeMode.danpsmLowToHigh the negotiation starts with the small value tries larger values with each iteration until the optimal value has been found. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TDeviceAutoNegotiatePacketSizeMode.

Note: Once the device is in use (has been initialized) this property will become (read-only). When using a 3rd party GenTL producer to access the GigE Vision device this feature will not be available.; This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getCapabilities()

PropertyI getCapabilities ( )

An enumerated integer property (read-only) defining special device capabilities.

This property stores certain device capabilities that can be read without opening the device.

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

◆ getCustomDataDirectory()

PropertyS getCustomDataDirectory ( )

A string property (read-only once the device is open) containing a path to a custom directory for the location of camera description files, etc.

When a custom path is assigned to this property this path will be used to locate certain driver specific files and folders. Under this folder the following structure must be created:

<customDataDirectory>
    |- CameraFiles  // this folder will be searched by frame grabbers for camera description files
    |- GenICam      // this folder will be searched by GenICam compliant devices that refer to a local GenICam&trade; description file

If this property is left empty

PUBLIC%/Documents/Balluff/ImpactAcquire will be used by default on Windows™ platforms and
/opt/ImpactAcquire/data on Unix based platforms.

◆ getDefaultRequestCount()

PropertyI getDefaultRequestCount ( )

An integer property that defines the number of mvIMPACT.acquire.Request objects to be created when the device is opened.

By writing to this property an application can define the default number of mvIMPACT.acquire.Request objects that will be allocated when opening the device.

Note: This property will become read-only while the device is open.

See also: mvIMPACT.acquire.SystemSettings.getRequestCount() to change the number of request objects later and to find out why this parameter is important

◆ getDesiredAccess()

PropertyI getDesiredAccess ( )

An enumerated integer property that can be used to define the desired access to the device when opening it.

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

Note: This property will become read-only while the device is open.; This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getDeviceClass()

PropertyI getDeviceClass ( )

An enumerated integer property (read-only) defining the device class this device belongs to.

Note: This property has been added to the device driver in version 1.8.3 thus might not be available when working with old device drivers. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getDeviceFamilyName()

PropertyS getDeviceFamilyName ( )

A string property (read-only) containing the family name of this device.

Since: 3.0.0

◆ getDeviceID()

PropertyI getDeviceID ( )

An integer property (read-only) containing the device ID associated with this device.

A device ID can be used to identify a certain device in the system. The ID is an 8 bit unsigned integer value stored in the device's EEPROM. In order to allow the distinct detection of a device via its device ID, the user has to make sure that two devices belonging to the same product family never share the same ID.

Note

REMARKS:

To modify the device ID a separate tool will be provided. To modify the device ID without that tool the function mvIMPACT.acquire.Device.setID can be called.
This ID is not to be confused with the handle returned by the function mvIMPACT.acquire.Device.hDev. The latter one represents something which can be assumed as a handle from a software based point of view, while the ID represented by the property deviceID is an ID stored in the physical devices EEPROM.

◆ getDeviceModelName()

PropertyS getDeviceModelName ( )

A string property (read-only) containing the model name of this device.

Since: 3.0.0

◆ getDeviceVersion()

PropertyS getDeviceVersion ( )

A string property (read-only) containing the version(e.g.

the hard ware revision) of this device.

Note: This feature is supported by every device driver. If a device does not seem to support this feature (calling mvIMPACT.acquire.Component.isValid returns false) a driver update will fix this.

◆ getFamily()

PropertyS getFamily ( )

A string property (read-only) containing the family name of this device.

Note: This is a legacy property only provided for backward compatibility. New applications should use mvIMPACT.acquire.Device.getDeviceFamilyName() instead!

◆ getFirmwareVersion()

PropertyI getFirmwareVersion ( )

An integer property (read-only) containing the firmware version of this device.

A firmware is considered to be something that is stored in non volatile device memory, thus when a device is disconnected from the power supply and plugged into a different target system the same code will be executed on the device.

Some devices however may not support non volatile memory to accommodate a firmware. Typically the device driver then will download a firmware into the devices RAM at startup. Such devices will be considered as not supporting a firmware as in this case only the driver version present on the target system has impact on the devices behaviour.

When a device does not support a non volatile firmware, reading this property will always return 0.

◆ getGrantedAccess()

PropertyI getGrantedAccess ( )

An enumerated integer property (read-only) that can be used to query the granted access to the device after an attempt to open it.

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

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ getHWUpdateResult()

PropertyI getHWUpdateResult ( )

An enumerated integer property (read-only) defining user executed hardware update results.

This property e.g. might contain the result of a user executed firmware update. Valid values for this property are defined by the enumeration mvIMPACT.acquire.THWUpdateResult.

◆ getInterfaceLayout()

PropertyI getInterfaceLayout ( )

An enumerated integer property which can be used to define which interface layout shall be used when the device is opened.

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

Note: Once the device is in use (has been initialized) this property will become (read-only).; This feature is available for every device. A device not offering this feature requires a driver update. Always check for the availability of this feature by calling mvIMPACT.acquire.Component.isValid.

Not every device will offer the same options. Check for valid modes by reading the properties translation dictionary with the functions mvIMPACT.acquire.PropertyIDeviceInterfaceLayout.getTranslationDictString and mvIMPACT.acquire.PropertyIDeviceInterfaceLayout.getTranslationDictValue.

◆ getLicenseDetails()

PropertyS getLicenseDetails ( )

A string property (read-only) that indicates why a device may be used with this SDK.

This property holds information on why a device may be used with Impact Acquire.

Note: This property will only be supported by some drivers (those allowing the usage of third party devices). Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

See also: mvIMPACT.acquire.Device.getLicenseValid()

Since: 2.46.0

◆ getLicenseValid()

PropertyI getLicenseValid ( )

A boolean property (read-only) that indicates if a device may be used with this SDK.

All Balluff imaging and image capture devices may be used with this SDK without limitations. Third party devices might work as well but without an appropriate license that can be obtained from Balluff certain restrictions may apply.

Note: This property will only be supported by some drivers (those allowing the usage of third party devices). Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

See also: mvIMPACT.acquire.Device.getLicenseDetails()

Since: 2.46.0

◆ getLoadSettings()

PropertyI getLoadSettings ( )

An enumerated integer property which can be used to define which previously stored setting to load when the device is opened.

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

Note: Once the device is in use (has been initialized) this property will become (read-only).

◆ getManufacturer()

PropertyS getManufacturer ( )

A string property (read-only) containing the name of the manufacturer of this device.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

Since: 2.11.3

◆ getManufacturerSpecificInformation()

PropertyS getManufacturerSpecificInformation ( )

A string property (read-only) containing manufacturer specific information of this device.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

Since: 2.18.3

◆ getProduct()

PropertyS getProduct ( )

A string property (read-only) containing the product name of this device.

Note: This is a legacy property only provided for backward compatibility. New applications should use mvIMPACT.acquire.Device.getDeviceModelName() instead!

◆ getResultQueueCount()

PropertyI getResultQueueCount ( )

An integer property that defines the number of result queues to be created when the device is opened.

By writing to this property an application can define the number of result queues that will be allocated when opening the device. When requesting buffers the user can define in which result queue a processed request shall end up by writing to the property mvIMPACT.acquire.ImageRequestControl.getResultQueue(). When waiting for a request to become ready by calling mvIMPACT.acquire.FunctionInterface.imageRequestWaitFor the application can specify on which queue to wait.

Device pDev = getDevicePointerFromSomewhere();
pDev.getResultQueueCount().write( 2 );
ImageRequestControl irc = new ImageRequestControl( pDev );
FunctionInterface fi = new FunctionInterface( pDev );
irc.getResultQueue().write( 0 );
fi.imageRequestSingle( irc ); // request a buffer that will be stored in queue 0 when ready
irc.getResultQueue().write( 1 );
fi.imageRequestSingle( irc ); // request a buffer that will be stored in queue 1 when ready
fi.imageRequestWaitFor( 500, 0 ); // wait on queue 0
fi.imageRequestWaitFor( 500, 1 ); // wait on queue 1

This can be useful e.g. when working with 2 different settings to sort all buffer capture with setting 0 into one queue and all the others into another queue.

Note: This property will become read-only while the device is open.

See also: mvIMPACT.acquire.ImageRequestControl.getResultQueue(),
mvIMPACT.acquire.FunctionInterface.imageRequestWaitFor

◆ getSerial()

PropertyS getSerial ( )

A string property (read-only) containing the serial number of this device.

◆ 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. Apart from that ALL GenICam/GenTL will only update this property automatically if the device is currently in use BY THIS PROCESS, so when the device has been opened. This is also to save bandwidth and resources!

◆ getStreamChannelCount()

PropertyI getStreamChannelCount ( )

An integer property providing the number of stream channels supported by this device.

This property can be useful for devices offering more (or less) than one stream channel. It might be useful to use it in combination with mvIMPACT.acquire.Device.getResultQueueCount() to change the number of result queues to allow the engine to store the resulting mvIMPACT.acquire.Request to a specific result queue.

Note: This property is only supported by GenICam&trade compliant devices.

See also: mvIMPACT.acquire.Device.getResultQueueCount()

◆ getUserControlledImageProcessingEnable()

PropertyI getUserControlledImageProcessingEnable ( )

An enumerated integer property defining whether user controlled image processing related features shall be created under 'System Settings' or not.

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

Setting this feature to mvIMPACT.acquire.TBoolean.bTrue will result in a separate thread being created when opening the device driver instance. The thread will decouple the host based image processing from the acquisition engine. Apart from that it will also create additional properties in the ImageProcessingControl list under SystemSettings that can be used to control the behaviour of this thread. This might be useful e.g. to make sure images can be acquired faster than they can be processed and it is not needed to processed each image.

Note: This property will become read-only while the device is open.

See also: mvIMPACT.acquire.SystemSettings.getImageProcessingMode()
mvIMPACT.acquire.Request.hasProcessingBeenSkipped

Since: 2.14.0

◆ getUserData()

UserData getUserData ( )

Returns a reference to a helper class to handle user specific data stored in the devices non-volatile memory(if available).

Returns: A reference to a helper class to handle user specific data stored in the devices non-volatile memory(if available).

◆ hasCapability()

boolean hasCapability ( int capability )

Checks whether this device has a certain capability.

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

Returns

true if the device has the capability in question
false otherwise.

Parameters

capability [in] The capability whose presence shall be checked.

◆ hasValidLicense()

boolean hasValidLicense ( )

Checks whether this device has a valid usage license.

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

Note: As the name indicates, this property returns if this device has a valid license. Not all third-party vendors are allowed to run with this SDK without limitations, so this function offers a way to check in advance if this is one of them.

Since: 2.46.0

Returns

true if the device has a valid license
false otherwise.

◆ hDev()

int hDev ( )

A unique identifier for this device.

Note: This handle is NOT to be confused with the id stored in the devices EEPROM The latter one represents a number stored somewhere in the physical device's EEPROM, while this handle can be assumed as a handle from a software based point of view.

◆ hDrv()

int hDrv ( )

A unique identifier for the functionality offered by this device.

Note: This identifier is only valid, if the device has been initialized before by a call to Device.open

◆ isInUse()

boolean isInUse ( )

Returns the current usage status of this device.

If this function returns true, this device was not in use at the time of calling this function. A call to mvIMPACT.acquire.Device.open() can still fail afterwards if some other process on the system claimed the device in the time between this call and the call to mvIMPACT.acquire.Device.open().

See also: Device.open,
Device.close

Since: 2.0.11

Returns

true if the device is in use by at least one process(this includes the calling process).
false otherwise.

◆ isOpen()

boolean isOpen ( )

Returns the current initialisation status in this process.

If this function returns true, this only states that the current process has not opened the device in question already. A call to mvIMPACT.acquire.Device.open() can still fail because of some other process using this device.

See also: Device.open,
Device.close

Returns

true if the device is initialized(opened) in the current process.
false otherwise.

◆ open()

void open ( )

Opens a device.

This function will try to open the device represented by this instance of mvIMPACT.acquire.Device. If this fails for any reason an exception will be thrown. The exception object will contain additional information about the reason for the error.

Calling this function is not really necessary, as each object for accessing other settings of the device or even the function interface need the device to be opened in order to be constructed. Therefore all the constructors for these objects check if the device is open by calling mvIMPACT.acquire.Device.isOpen and open the device if necessary.

Note: Keep in mind that the first object trying to open the device might therefore throw an exception as well if opening the device fails for some reason.

Whenever a device is opened, the driver executes the following procedure:

Device setting start procedure

Please have a look here for more information about automatic loading of settings when a device is opened.

◆ setID()

int setID ( int newID )

Assigns a new ID to this device.

To allow any application to distinguish between different devices of the same type the user can assign a unique ID to each device using this function. This ID currently is limited to values between 0 and 250 and is stored in the devices internal memory. This ID is NOT volatile. It will remain stored even if the device is unplugged.

Note

REMARKS:

The device must be closed to assign a new ID.
This ID is not to be confused with the handle returned by the function mvIMPACT.acquire.Device.hDev. The latter one represents something which can be assumed as a handle from a software based point of view, while the ID represented by the property mvIMPACT.acquire.Device.getDeviceID() is an ID stored in the physical devices EEPROM.
Not every device will offer this feature! When calling this function for a device that does not offer this feature, the function will return mvIMPACT.acquire.TDMR_ERROR.DMR_FEATURE_NOT_AVAILABLE.

See also: mvIMPACT.acquire.Device.open,
mvIMPACT.acquire.Device.close

Returns

mvIMPACT.acquire.TDMR_ERROR.DMR_NO_ERROR if successful.
A negative error code of type mvIMPACT.acquire.TDMR_ERROR otherwise.

Parameters

newID [in] The new ID that shall be assigned to the device.

◆ swigRelease()

static long swigRelease ( Device obj )

staticprotected

◆ updateFirmware()

int updateFirmware ( )

Updates the firmware of the device.

Calling this function will cause the driver to download a firmware version compiled into the driver library into the devices non-volatile internal memory.

Note

This feature currently is only available for mvBlueFOX devices. To update the firmware of other devices please refer to the tool DeviceConfigure(this tool also offers a command-line interface)
Be sure you know what you are doing before calling this function. Under normal circumstances it won't be necessary to update a devices firmware.
The download will take some time (depending on the device up to 30 seconds). During this time the device and the thread calling this function will NOT respond.
Do NOT interrupt this download.
After a successful download a USB device needs to be unplugged and plugged in again. Otherwise the new firmware version will not be activated.
To download a new firmware version the device must be closed.
Not every device will offer this feature! When calling this function for a device that does not offer this feature, the function will return mvIMPACT.acquire.TDMR_ERROR.DMR_FEATURE_NOT_AVAILABLE.

See also: mvIMPACT.acquire.Device.open,
mvIMPACT.acquire.Device.close

Returns

mvIMPACT.acquire.TDMR_ERROR.DMR_NO_ERROR if successful.
A negative error code of type mvIMPACT.acquire.TDMR_ERROR otherwise.

◆ validateInterfaceLayout()

void validateInterfaceLayout ( int requiredInterfaceLayout )

A convenience function mostly used internally.

Raises an exception if the current value of mvIMPACT.acquire.Device.getInterfaceLayout() does not match the value passed to the function.

If a driver does not support the interface layout property this function does nothing!

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn

protected

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Device() [1/2]

◆ Device() [2/2]

Member Function Documentation

◆ close()

◆ delete()

◆ deviceDriverFeatureList()

◆ finalize()

◆ getAcquisitionStartStopBehaviour()

◆ getAllowUnrecommendedFeatures()

◆ getAutoLoadSettingOrder()

◆ getAutoNegotiatePacketSize()

◆ getAutoNegotiatePacketSizeMode()

◆ getCapabilities()

◆ getCustomDataDirectory()

◆ getDefaultRequestCount()

◆ getDesiredAccess()

◆ getDeviceClass()

◆ getDeviceFamilyName()

◆ getDeviceID()

◆ getDeviceModelName()

◆ getDeviceVersion()

◆ getFamily()

◆ getFirmwareVersion()

◆ getGrantedAccess()

◆ getHWUpdateResult()

◆ getInterfaceLayout()

◆ getLicenseDetails()

◆ getLicenseValid()

◆ getLoadSettings()

◆ getManufacturer()

◆ getManufacturerSpecificInformation()

◆ getProduct()

◆ getResultQueueCount()

◆ getSerial()

◆ getState()

◆ getStreamChannelCount()

◆ getUserControlledImageProcessingEnable()

◆ getUserData()

◆ hasCapability()

◆ hasValidLicense()

◆ hDev()

◆ hDrv()

◆ isInUse()

◆ isOpen()

◆ open()

◆ setID()

◆ swigRelease()

◆ updateFirmware()

◆ validateInterfaceLayout()

Member Data Documentation

◆ swigCMemOwn