Represents one interface (network adapter or USB host controller) on a system (the PC) More...

#include <PvInterface.h>

Public Member Functions
virtual	~PvInterface ()
	Destructor.

PvInterface *	Copy () const
	Creates a copy of the PvInterface object. More...

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...

PvString	GetPleoraDriverVersion () const
	Get the eBUS driver version installed on this PvInterface. More...

Static Public Member Functions
static bool	Compare (const PvInterface a1, const PvInterface a2)
	Static method used for sorting interfaces. More...

Detailed Description

Represents one interface (network adapter or USB host controller) on a system (the PC)

To use this class, see PvSystem.

Member Function Documentation

◆ Compare()

bool PvInterface::Compare	(	const PvInterface *	a1,
		const PvInterface *	a2
	)

static

Static method used for sorting interfaces.

Parameters

[in]	a1	A first interface.
[in]	a2	A second interface.

Returns

true if the value of the first character that doesn't match is lower in a1's ID or all compared characters match but the compared ID is shorter.
false otherwise.

◆ Copy()

PvInterface* PvInterface::Copy ( ) const

Creates a copy of the PvInterface 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.

Returns: Pointer to the PvInterface copy. The user is reponsable to delete/free this pointer.

◆ GetCompareID()

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.

Returns: String that can be used to sort interfaces.

◆ GetDeviceCount()

uint32_t PvInterface::GetDeviceCount ( ) const

Get the number of found devices on this PvInterface.

Returns: The number of devices found through this PvInterface.

◆ GetDeviceInfo()

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.

Parameters

[in] aIndex The device's array position. The zero-based parameter accepts 0 through GetDeviceCount-1.

Returns: Information identifying a device; a PvDeviceInfo object. If aIndex is out of bounds, the return is NULL.

◆ GetDisplayID()

PvString PvInterface::GetDisplayID ( ) const

Get a string that can be used in a user interface to identify the interface.

Returns: The interface's display ID.

◆ GetName()

PvString PvInterface::GetName ( ) const

Get the description of the NIC, as reported by the OS.

Returns: The description of the NIC, as reported by the OS. The value is intended only for human reading.

◆ GetPleoraDriverVersion()

PvString PvInterface::GetPleoraDriverVersion ( ) const

Get the eBUS driver version installed on this PvInterface.

Returns a string holding the Pleora driver version on this network interface.

Returns

The eBUS driver version, if installed. The numbers are, in order: the major, minor, subminor and build number (format: #.#.#.#.####).
An empty string if the eBUS driver is not currently installed on the interface.

◆ GetType()

PvInterfaceType PvInterface::GetType ( ) const

Get the interface type.

Returns: Type of interface (network interface or USB host controller). See PvInterfaceType Enum.

◆ GetUniqueID()

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.

Returns: The interface's unique ID.

The documentation for this class was generated from the following files:

PvInterface.h
PvInterface.cpp

eBUS SDK v6.5.1.6797 API

Public Member Functions

Static Public Member Functions