- Generated on Thu Nov 14 2024 18:44:32
|
Impact Acquire SDK Java
|
Category contains items that belong to the device module of the transport layer. More...
Public Member Functions | |
| synchronized void | delete () |
| DeviceModule (Device pDev) | |
| Constructs a new mvIMPACT.acquire.DeviceModule object. | |
| DeviceModule (Device pDev, String settingName) | |
| Constructs a new mvIMPACT.acquire.DeviceModule object. | |
| PropertyI64 | getDeviceAccessStatus () |
| An enumerated integer property. | |
| PropertyI64 | getDeviceChunkDataFormat () |
| An enumerated integer property. | |
| PropertyS | getDeviceDisplayName () |
| A string property. | |
| PropertyI64 | getDeviceEndianessMechanism () |
| An enumerated integer property. | |
| PropertyI64 | getDeviceEventDataFormat () |
| An enumerated integer property. | |
| PropertyS | getDeviceFamilyName () |
| A string property. | |
| PropertyS | getDeviceID () |
| A string property. | |
| PropertyS | getDeviceManufacturerInfo () |
| A string property. | |
| PropertyS | getDeviceModelName () |
| A string property. | |
| PropertyS | getDeviceSerialNumber () |
| A string property. | |
| PropertyI64 | getDeviceTimestampFrequency () |
| An integer property. | |
| PropertyI64 | getDeviceType () |
| An enumerated integer property. | |
| PropertyS | getDeviceUserID () |
| A string property. | |
| PropertyS | getDeviceVendorName () |
| A string property. | |
| PropertyS | getDeviceVersion () |
| A string property. | |
| PropertyI64 | getEventNotification () |
| An enumerated integer property. | |
| PropertyI64 | getEventSelector () |
| An enumerated integer property. | |
| PropertyI64 | getGenCPVersionMajor () |
| An integer property. | |
| PropertyI64 | getGenCPVersionMinor () |
| An integer property. | |
| PropertyI64 | getGevDeviceGateway () |
| An integer property. | |
| PropertyI64 | getGevDeviceIPAddress () |
| An integer property. | |
| PropertyI64 | getGevDeviceMACAddress () |
| An integer property. | |
| PropertyI64 | getGevDeviceSubnetMask () |
| An integer property. | |
| PropertyI64 | getGevVersionMajor () |
| An integer property. | |
| PropertyI64 | getGevVersionMinor () |
| An integer property. | |
| PropertyI64 | getLinkCommandRetryCount () |
| An integer property. | |
| PropertyF | getLinkCommandTimeout () |
| A floating point property. | |
| PropertyS | getMvDeviceLicenseDetails () |
| A string property. | |
| PropertyI | getMvDeviceLicenseValid () |
| A boolean property. | |
| PropertyI64 | getMvGevDeviceCCSP () |
| An integer property. | |
| PropertyI64 | getMvLinkCommandTimeoutCheckGranularity () |
| An integer property. | |
| PropertyS | getMvU3VDeviceGUID () |
| A string property. | |
| PropertyS | getStreamID () |
| A string property. | |
| PropertyI64 | getStreamSelector () |
| An integer property. | |
| PropertyI64 | getU3vVersionMajor () |
| An integer property. | |
| PropertyI64 | getU3vVersionMinor () |
| An integer property. | |
| int | hObj () |
| Returns a unique identifier for the component collection referenced by this object. | |
| ComponentCollection | restoreDefault () |
| Restores the default for every component of this collection. | |
Protected Member Functions | |
| DeviceModule (long cPtr, boolean cMemoryOwn) | |
| void | finalize () |
Static Protected Member Functions | |
| static long | swigRelease (ComponentCollection obj) |
| static long | swigRelease (DeviceModule obj) |
Protected Attributes | |
| transient boolean | swigCMemOwn |
Category contains items that belong to the device module of the transport layer.
The Device category contains items that belong to the device module of the transport layer.
|
protected |
| DeviceModule | ( | Device | pDev, |
| String | settingName ) |
Constructs a new mvIMPACT.acquire.DeviceModule object.
| 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 |
| DeviceModule | ( | Device | pDev | ) |
Constructs a new mvIMPACT.acquire.DeviceModule object.
| 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 |
| synchronized void delete | ( | ) |
Reimplemented from ComponentCollection.
|
protected |
Reimplemented from ComponentCollection.
| PropertyI64 getDeviceAccessStatus | ( | ) |
An enumerated integer property.
Indicates the current access status for the device.
This is a read only feature. This enumeration gives the device's access status at the moment of the last execution of the DeviceUpdateList command. This value only changes on execution of the DeviceUpdateList command.
The following string values might be valid for this feature:
| PropertyI64 getDeviceChunkDataFormat | ( | ) |
An enumerated integer property.
Indicates the chunk data format used by the remote device.
This is a read only feature. This enumeration provides a value that indicates the chunk data format used by the remote device.
The following string values might be valid for this feature:
| PropertyS getDeviceDisplayName | ( | ) |
A string property.
Indicates user readable name for the remote device.
This is a read only element. It is a string that indicates user readable name for the remote device model.
| PropertyI64 getDeviceEndianessMechanism | ( | ) |
An enumerated integer property.
Identifies the endianess mode to be used for this device.
This is a read only feature. This enumeration provides a value that indicates the endianess mode to be used for this device.
The following string values might be valid for this feature:
| PropertyI64 getDeviceEventDataFormat | ( | ) |
An enumerated integer property.
Indicates the event data format used by the remote device.
This is a read only feature. This enumeration provides a value that indicates the event data format used by the remote device.
The following string values might be valid for this feature:
| PropertyS getDeviceFamilyName | ( | ) |
A string property.
Identifier of the product family of the device.
Identifier of the product family of the device.
| PropertyS getDeviceID | ( | ) |
A string property.
This feature is deprecated (See DeviceSerialNumber).
| PropertyS getDeviceManufacturerInfo | ( | ) |
A string property.
Manufacturer information about the device.
Manufacturer information about the device.
| PropertyS getDeviceModelName | ( | ) |
A string property.
Model of the device.
Model of the device.
| PropertyS getDeviceSerialNumber | ( | ) |
A string property.
Device's serial number.
Device's serial number. This string is a unique identifier of the device.
| PropertyI64 getDeviceTimestampFrequency | ( | ) |
An integer property.
Indicates the tick-frequency of the timestamp clock of the remote device.
Indicates the tick-frequency of the timestamp clock of the remote device.
| PropertyI64 getDeviceType | ( | ) |
An enumerated integer property.
Returns the device type.
Returns the device type.
The following string values might be valid for this feature:
| PropertyS getDeviceUserID | ( | ) |
A string property.
User-programmable device identifier.
User-programmable device identifier.
| PropertyS getDeviceVendorName | ( | ) |
A string property.
Name of the manufacturer of the device.
Name of the manufacturer of the device.
| PropertyS getDeviceVersion | ( | ) |
A string property.
Version of the device.
Version of the device.
| PropertyI64 getEventNotification | ( | ) |
An enumerated integer property.
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
The following string values might be valid for this feature:
| PropertyI64 getEventSelector | ( | ) |
An enumerated integer property.
Selects which Event to signal to the host application.
Selects which Event to signal to the host application.
The following string values might be valid for this feature:
| PropertyI64 getGenCPVersionMajor | ( | ) |
An integer property.
Indicates the major version number of the GenCP specification this device complies with.
This is a read only element. It indicates the major version number of the GenCP specification this device complies with.
| PropertyI64 getGenCPVersionMinor | ( | ) |
An integer property.
Indicates the minor version number of the GenCP specification this device complies with.
This is a read only element. It indicates the minor version number of the GenCP specification this device complies with.
| PropertyI64 getGevDeviceGateway | ( | ) |
An integer property.
Indicates the current gateway of the GVCP interface of the selected remote device.
This is a read only element. It indicates the current gateway of the GVCP interface of the selected remote device.
| PropertyI64 getGevDeviceIPAddress | ( | ) |
An integer property.
Indicates the current IP address of the GVCP interface of the selected remote device.
This is a read only element. It indicates the current IP address of the GVCP interface of the selected remote device.
| PropertyI64 getGevDeviceMACAddress | ( | ) |
An integer property.
Indicates the 48-bit MAC address of the GVCP interface of the selected remote device.
This is a read only element. It indicates the 48-bit MAC address of the GVCP interface of the selected remote device.
| PropertyI64 getGevDeviceSubnetMask | ( | ) |
An integer property.
Indicates the current subnet mask of the GVCP interface of the selected remote device.
This is a read only element. It indicates the current subnet mask of the GVCP interface of the selected remote device.
| PropertyI64 getGevVersionMajor | ( | ) |
An integer property.
Indicates the major version number of the GigE Vision specification this device complies with.
This is a read only element. It indicates the major version number of the GigE Vision specification this device complies with.
| PropertyI64 getGevVersionMinor | ( | ) |
An integer property.
Indicates the minor version number of the GigE Vision specification this device complies with.
This is a read only element. It indicates the minor version number of the GigE Vision specification this device complies with.
| PropertyI64 getLinkCommandRetryCount | ( | ) |
An integer property.
Specifies maximum number of tries before failing the control channel commands.
This feature specifies maximum number of tries before failing the control channel commands.
| PropertyF getLinkCommandTimeout | ( | ) |
A floating point property.
Specifies application timeout for the control channel communication.
The feature specifies application timeout for the control channel communication. It defines the application timeout, and it is related to the device feature DeviceLinkCommandTimeout specifying the maximum time for handling a command in the device. Up to DeviceLinkCommandRetryCount attempts with this timeout are made before a command fails with a timout error.
| PropertyS getMvDeviceLicenseDetails | ( | ) |
A string property.
Details about the granted license.
This is a read only element. It indicates details whether or not this device can be operated without limitations using this driver stack.
| PropertyI getMvDeviceLicenseValid | ( | ) |
A boolean property.
True if the current device has a valid license.
True if the current device has a valid license. This is the case for all devices manufactured by the same vendor as this SDK and devices for which a license file has been provided.
| PropertyI64 getMvGevDeviceCCSP | ( | ) |
An integer property.
The port of the control channel the device is using (usually 3956).
The port of the control channel the device is using (usually 3956).
| PropertyI64 getMvLinkCommandTimeoutCheckGranularity | ( | ) |
An integer property.
Indicates how often the driver shall check the link during one 'DeviceLinkCommandTimeout' interval.
Indicates how often the driver shall check the link during one 'DeviceLinkCommandTimeout' interval. The higher this value the more often the link will be checked. However additional traffic on the link is only generated if no other communication like polling certain registers, reading or writing is performed by an application. A higher value will result in a faster notification in case a device has been physically been unplugged.
| PropertyS getMvU3VDeviceGUID | ( | ) |
A string property.
Indicates the USB3 Vision GUID of the device.
This is a read only element. It indicates the USB3 Vision GUID of the device.
| PropertyS getStreamID | ( | ) |
A string property.
Device wide unique ID of the selected stream.
This is a read only element. It is a string that indicates a device wide unique identifier of the selected stream.
| PropertyI64 getStreamSelector | ( | ) |
An integer property.
Selects the stream channel.
Selects the stream channel.
| PropertyI64 getU3vVersionMajor | ( | ) |
An integer property.
Indicates the major version number of the USB3 Vision specification this device complies with.
This is a read only element. It indicates the major version number of the USB3 Vision specification this device complies with.
| PropertyI64 getU3vVersionMinor | ( | ) |
An integer property.
Indicates the minor version number of the USB3 Vision specification this device complies with.
This is a read only element. It indicates the minor version number of the USB3 Vision specification this device complies with.
|
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.
|
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.
|
staticprotectedinherited |
|
staticprotected |
|
protectedinherited |