Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDeviceInfoU3V Class Reference

Information about a USB3 Vision device. More...

Public Member Functions

 PvDeviceInfoU3V ()
 Constructor.
 
virtual ~PvDeviceInfoU3V ()
 Destructor.
 
PvDeviceInfoU3Voperator= (const PvDeviceInfoU3V &)
 Equal operator: copies the object. More...
 
uint32_t GetGenCPVersion () const
 Get the USB3 Vision device's GenCP protocol version. More...
 
uint32_t GetU3VVersion () const
 Get the USB3 Vision device's USB3 Vision protocol version. More...
 
PvString GetDeviceGUID () const
 Get the USB3 Vision GUID of the device. More...
 
PvString GetFamilyName () const
 Returns the family name of the device. More...
 
PvString GetU3VSerialNumber () const
 Returns the U3V serial number of the device. More...
 
PvString GetDevicePath () const
 Returns the U3V device path. More...
 
PvString GetDeviceKey () const
 Returns the U3V device key. More...
 
PvString GetSpeedMessage () const
 Get a message of the speed negotiated between the controller and the device (low, high, full, super) or an error message. More...
 
PvString GetPowerMessage () const
 Get a message of whether device is powered properly or not. More...
 
bool IsLowSpeedSupported () const
 Returns true if the device supports USB1.0 speed. More...
 
bool IsFullSpeedSupported () const
 Returns true if the device supports USB1.1 speed. More...
 
bool IsHighSpeedSupported () const
 Returns true if the device supports USB2 speed. More...
 
bool IsSuperSpeedSupported () const
 Returns true if the device supports USB3 speed. More...
 
bool IsCurrentSpeedSupported () const
 Returns true if the current speed of the device is supported by the host controller. More...
 
PvUSBSpeed GetSpeed () const
 Returns the currently effective connection speed of the USB3 Vision device. More...
 
uint32_t GetMaxPower () const
 Power consumption of the device in milliamp. More...
 
uint32_t GetMaxPacketSize () const
 Maximum packet size that can be used by the device in bytes. More...
 
bool IsPleoraDriverInstalled () const
 Returns true if the currently selected driver for the device is the Pleora driver. More...
 
bool IsInitializedCapabilities () const
 Returns true if the device U3V capabilities were retrieved and initialized. More...
 
- Public Member Functions inherited from PvDeviceInfoUSB
 PvDeviceInfoUSB ()
 Constructor.
 
virtual ~PvDeviceInfoUSB ()
 Destructor.
 
PvDeviceInfoUSBoperator= (const PvDeviceInfoUSB &)
 Equal operator: copies the object. More...
 
PvUSBStatus GetStatus () const
 Returns the enumeration status of the USB device. More...
 
- Public Member Functions inherited from PvDeviceInfo
virtual ~PvDeviceInfo ()
 Destructor.
 
PvDeviceInfoCopy () 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 PvInterfaceGetInterface () 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...
 

Detailed Description

Information about a USB3 Vision device.

Member Function Documentation

◆ GetDeviceGUID()

PvString PvDeviceInfoU3V::GetDeviceGUID ( ) const

Get the USB3 Vision GUID of the device.

GUID stands for "Globally Unique Identifier". It is the USB3 Vision counterpart of the MAC of a GigE Vision device.

Returns
USB3 Vision GUID of the device.

◆ GetDeviceKey()

PvString PvDeviceInfoU3V::GetDeviceKey ( ) const

Returns the U3V device key.

Cryptic, internal device key used to load the driver for a device from a device info.

Returns
U3V device key.

◆ GetDevicePath()

PvString PvDeviceInfoU3V::GetDevicePath ( ) const

Returns the U3V device path.

Cryptic, internal device key used to load the driver for a device from a device info.

Returns
U3V device key.

◆ GetFamilyName()

PvString PvDeviceInfoU3V::GetFamilyName ( ) const

Returns the family name of the device.

Returns
Family name of the device.

◆ GetGenCPVersion()

uint32_t PvDeviceInfoU3V::GetGenCPVersion ( ) const

Get the USB3 Vision device's GenCP protocol version.

The high 16 bits contain the major version and The low 16 bits the minor version.

Returns
The USB3 Vision device's GenCP protocol version.

◆ GetMaxPacketSize()

uint32_t PvDeviceInfoU3V::GetMaxPacketSize ( ) const

Maximum packet size that can be used by the device in bytes.

Returns
Maximum packet size.

◆ GetMaxPower()

uint32_t PvDeviceInfoU3V::GetMaxPower ( ) const

Power consumption of the device in milliamp.

Returns
Power consumption of the device.

◆ GetPowerMessage()

PvString PvDeviceInfoU3V::GetPowerMessage ( ) const

Get a message of whether device is powered properly or not.

This string provides information on whether the device seems to be powered properly or not

Returns
A string indicating 'Ok' if devices seems to be powered or an error message (e.g. "Ensure correct power") otherwise

◆ GetSpeed()

PvUSBSpeed PvDeviceInfoU3V::GetSpeed ( ) const

Returns the currently effective connection speed of the USB3 Vision device.

If a device supporting super speed is connected in a slower hub or controller it is not able to negotiate up to its maximum supported speed.

If a device IsSuperSpeedSupported returns true and GetSpeed returns something slower look into the supported speed of the hubs chain to the controller or the controller itself.

Returns
Effective connection speed.

◆ GetSpeedMessage()

PvString PvDeviceInfoU3V::GetSpeedMessage ( ) const

Get a message of the speed negotiated between the controller and the device (low, high, full, super) or an error message.

Returns
A string indicating the negotiated speed ('low', 'high', 'full', 'super') or an error message: 'Unknown' if the negotiation speed is not known 'Connect to USB 3.0 port" if a device that can only support higher speeds is connected to lower speed ports

◆ GetU3VSerialNumber()

PvString PvDeviceInfoU3V::GetU3VSerialNumber ( ) const

Returns the U3V serial number of the device.

Returns
U3V serial number of the device.

◆ GetU3VVersion()

uint32_t PvDeviceInfoU3V::GetU3VVersion ( ) const

Get the USB3 Vision device's USB3 Vision protocol version.

The high 16 bits contain the major version and The low 16 bits the minor version.

Returns
The USB3 Vision device's USB3 Vision protocol version.

◆ IsCurrentSpeedSupported()

bool PvDeviceInfoU3V::IsCurrentSpeedSupported ( ) const

Returns true if the current speed of the device is supported by the host controller.

Returns
True if the host controller supports the current speed of the device.

◆ IsFullSpeedSupported()

bool PvDeviceInfoU3V::IsFullSpeedSupported ( ) const

Returns true if the device supports USB1.1 speed.

Returns
True if the device supports full speed.

◆ IsHighSpeedSupported()

bool PvDeviceInfoU3V::IsHighSpeedSupported ( ) const

Returns true if the device supports USB2 speed.

Returns
True if the device supports high speed.

◆ IsInitializedCapabilities()

bool PvDeviceInfoU3V::IsInitializedCapabilities ( ) const

Returns true if the device U3V capabilities were retrieved and initialized.

Returns
True if the device's capabilities are accessible, false otherwise (indicating device may not be powered properly)

◆ IsLowSpeedSupported()

bool PvDeviceInfoU3V::IsLowSpeedSupported ( ) const

Returns true if the device supports USB1.0 speed.

Returns
True if the device supports low speed.

◆ IsPleoraDriverInstalled()

bool PvDeviceInfoU3V::IsPleoraDriverInstalled ( ) const

Returns true if the currently selected driver for the device is the Pleora driver.

Returns
True is the device is using the Pleora driver.

◆ IsSuperSpeedSupported()

bool PvDeviceInfoU3V::IsSuperSpeedSupported ( ) const

Returns true if the device supports USB3 speed.

Returns
True if the device supports super speed.

◆ operator=()

PvDeviceInfoU3V & PvDeviceInfoU3V::operator= ( const PvDeviceInfoU3V aFrom)

Equal operator: copies the object.

Parameters
[in]aFromThe source for the copy.
Returns
Reference to the object aFrom was copied to.

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com