Represents one interface (network adapter or USB host controller) on a system (the PC) More...
Public Member Functions | |
virtual | ~PvInterface () |
Destructor. | |
PvInterfaceType | GetType () const |
Get the interface type. More... | |
PvString | GetName () const |
Get the description of the NIC, as reported by the OS. More... | |
PvString | GetDisplayID () const |
Get a string that can be used in a user interface to identify the interface. More... | |
PvString | GetUniqueID () const |
Get a string uniquely identifying the interface. More... | |
PvString | GetCompareID () const |
Get a string that can be used to sort interfaces. More... | |
uint32_t | GetDeviceCount () const |
Get the number of found devices on this PvInterface. More... | |
const PvDeviceInfo * | GetDeviceInfo (uint32_t aIndex) const |
Get information identifying a device. More... | |
Static Public Member Functions | |
static bool | Compare (const PvInterface *a1, const PvInterface *a2) |
Static method used for sorting interfaces. More... | |
Represents one interface (network adapter or USB host controller) on a system (the PC)
To use this class, see PvSystem.
|
static |
Static method used for sorting interfaces.
[in] | a1 | A first interface. |
[in] | a2 | A second interface. |
PvString PvInterface::GetCompareID | ( | ) | const |
Get a string that can be used to sort interfaces.
The content of the compare 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 compare other interface sorting IDs to allow consistent sorting and ordering of interfaces, typically in a user interface context.
uint32_t PvInterface::GetDeviceCount | ( | ) | const |
Get the number of found devices on this PvInterface.
const PvDeviceInfo * PvInterface::GetDeviceInfo | ( | uint32_t | aIndex | ) | const |
Get information identifying a device.
Returns information identifying a device discovered on this interface (network adapter or USB host controller). This information can be used to connect and control it with a PvDevice object.
To connect, use PvDevice::CreateAndConnect (supports both GigE Vision and USB3 Vision devices), PvDeviceGEV::Connect or PvDeviceU3V::Connect.
[in] | aIndex | The device's array position. The zero-based parameter accepts 0 through GetDeviceCount-1. |
PvString PvInterface::GetDisplayID | ( | ) | const |
Get a string that can be used in a user interface to identify the interface.
PvString PvInterface::GetName | ( | ) | const |
Get the description of the NIC, as reported by the OS.
PvInterfaceType PvInterface::GetType | ( | ) | const |
Get the interface type.
PvString PvInterface::GetUniqueID | ( | ) | const |
Get a string uniquely identifying the interface.
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 interface unique IDs from within the same application life cycle.
Do not assume the unique ID will be using a MAC address for network adapters or anything specifc for USB host controllers.
If you need the MAC address of a network adapter, use PvNetworkAdapter::GetMACAddress.
If you need specific information about a USB host controller, use the PvUSBHostController class.
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com