Information identifying a device. More...
Public Member Functions | |
virtual | ~PvDeviceInfo () |
Destructor. | |
PvDeviceInfo * | Copy () const |
Creates a copy of the PvDeviceInfo object. More... | |
PvDeviceInfoType | GetType () const |
Returns the type of the device info object. More... | |
PvString | GetVendorName () const |
Get the device's manufacturer name. More... | |
PvString | GetModelName () const |
Get the device's model name. More... | |
PvString | GetVersion () const |
Get the device's version. More... | |
PvString | GetManufacturerInfo () const |
Get the manufacturer information returned by the device. More... | |
PvString | GetSerialNumber () const |
Get the GigE Vision device's serial number. More... | |
PvString | GetUserDefinedName () const |
Get the device's user defined name. More... | |
PvString | GetLicenseMessage () const |
Get a message of whether license is valid, and if not why. More... | |
PvString | GetDisplayID () const |
Get a string identifying this device for display purpose. More... | |
PvString | GetUniqueID () const |
Get a string uniquely identifying this device. More... | |
PvString | GetConnectionID () const |
Get a unique string identifying this device for connection purpose. More... | |
const PvInterface * | GetInterface () const |
Get the network adapter (PvInterface) through which this device was reached. More... | |
bool | IsConfigurationValid () const |
Test if the device can be reached as currently configured. More... | |
bool | IsLicenseValid () const |
Test if the eBUS SDK license is valid for this device. More... | |
PvDeviceClass | GetClass () const |
Get the device class. More... | |
Information identifying a device.
PvDeviceInfo provides information about a device (GigE Vision, USB3 Vision or Pleora Protocol) as found by either PvSystem/PvInterface or device finder dialog.
To use PvDeviceInfo, see PvDevice.
PvDeviceInfo * PvDeviceInfo::Copy | ( | ) | const |
Creates a copy of the PvDeviceInfo object.
The user is responsible from freeing/deleting the object after use. The object is fully detached from PvSystem or the device finder dialog object.
PvDeviceClass PvDeviceInfo::GetClass | ( | ) | const |
Get the device class.
PvString PvDeviceInfo::GetConnectionID | ( | ) | const |
Get a unique string identifying this device for connection purpose.
This string can be used with the factory methods of PvDevice and PvStream to create a GigE Vision device or USB3 Vision device from generic PvDeviceInfo.
PvString PvDeviceInfo::GetDisplayID | ( | ) | const |
Get a string identifying this device for display purpose.
const PvInterface * PvDeviceInfo::GetInterface | ( | ) | const |
Get the network adapter (PvInterface) through which this device was reached.
PvString PvDeviceInfo::GetLicenseMessage | ( | ) | const |
Get a message of whether license is valid, and if not why.
This string provides information on validity of the license. If the license is valid, then it is simply 'valid'. Otherwise, the reason for the invalidity is provided as a string.
PvString PvDeviceInfo::GetManufacturerInfo | ( | ) | const |
Get the manufacturer information returned by the device.
PvString PvDeviceInfo::GetModelName | ( | ) | const |
Get the device's model name.
PvString PvDeviceInfo::GetSerialNumber | ( | ) | const |
Get the GigE Vision device's serial number.
PvDeviceInfoType PvDeviceInfo::GetType | ( | ) | const |
Returns the type of the device info object.
PvString PvDeviceInfo::GetUniqueID | ( | ) | const |
Get a string uniquely identifying this device.
The content of the unique ID is not garanteed to be represent anything or to be constant between revisions of the eBUS SDK. It should only be used to opaquely, uniquely match other device unique IDs from within the same application life cycle.
Do not assume the unique ID will be using a MAC address for network devices or the USB GUID for USB devices.
If you need the MAC address of a GigE Vision device, use PvDeviceInfoGEV::GetMACAddress.
If you need the USB GUID of a USB3 Vision device, use PvDeviceInfoU3V::GetGUID.
PvString PvDeviceInfo::GetUserDefinedName | ( | ) | const |
Get the device's user defined name.
This feature is only supported by devices having persistence memory. It can therefor be blank if not supported by the device, or simply not yet assigned.
PvString PvDeviceInfo::GetVendorName | ( | ) | const |
Get the device's manufacturer name.
PvString PvDeviceInfo::GetVersion | ( | ) | const |
Get the device's version.
bool PvDeviceInfo::IsConfigurationValid | ( | ) | const |
Test if the device can be reached as currently configured.
This method compares the GigE Vision device and NIC's IP configurations to ensure they are on the same subnet. For USB3 Vision devices, the configuration is considered valid if the device can be enumerated and the Pleora driver is associated to the device.
bool PvDeviceInfo::IsLicenseValid | ( | ) | const |
Test if the eBUS SDK license is valid for this device.
To connect to third-party devices, the eBUS SDK requires a valid license. If you don't have a license, contact sales.
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com