Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDeviceInfoPleoraProtocol Class Reference

Information about a Pleora Protocol device. More...

Public Member Functions

 PvDeviceInfoPleoraProtocol ()
 Constructor.
 
virtual ~PvDeviceInfoPleoraProtocol ()
 Destructor.
 
PvDeviceInfoPleoraProtocoloperator= (const PvDeviceInfoPleoraProtocol &)
 Equal operator: copies the object. More...
 
PvString GetMACAddress () const
 Get the Pleora Protocol device's MAC address. More...
 
PvString GetIPAddress () const
 Get the Pleora Protocol device's current IP address. More...
 
PvString GetSubnetMask () const
 Get the Pleora Protocol device's subnet mask. More...
 
PvString GetDefaultGateway () const
 Get the Pleora Protocol device's default gateway. More...
 
uint8_t GetDeviceID () const
 Returns the Device ID of the Pleora Protocol device. More...
 
uint8_t GetModuleID () const
 Returns the Module ID of the Pleora Protocol device. More...
 
uint8_t GetSubID () const
 Returns the Sub ID of the Pleora Protocol device. More...
 
uint8_t GetVendorID () const
 Returns the Vendor ID of the Pleora Protocol device. More...
 
uint8_t GetSoftwareMajor () const
 Major version of the firmware running on the Pleora Protocol device. More...
 
uint8_t GetSoftwareMinor () const
 Minor version of the firmware running on the Pleora Protocol 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 Pleora Protocol device.

The eBUS SDK allows enumerating devices using the Pleora protocol. However, it does not allow connecting to or controlling these device.

Member Function Documentation

◆ GetDefaultGateway()

PvString PvDeviceInfoPleoraProtocol::GetDefaultGateway ( ) const

Get the Pleora Protocol device's default gateway.

Returns
The Pleora Protocol device's default gateway; the GevCurrentDefaultGateway feature. For the form, see GetIPAddress.

◆ GetDeviceID()

uint8_t PvDeviceInfoPleoraProtocol::GetDeviceID ( ) const

Returns the Device ID of the Pleora Protocol device.

Returns
Device ID.

◆ GetIPAddress()

PvString PvDeviceInfoPleoraProtocol::GetIPAddress ( ) const

Get the Pleora Protocol device's current IP address.

Returns
The Pleora Protocol device's current IP address; the GevCurrentIPAddress feature. The form is a.b.c.d, where a through d are decimal numbers ranging from 0 to 255.

◆ GetMACAddress()

PvString PvDeviceInfoPleoraProtocol::GetMACAddress ( ) const

Get the Pleora Protocol device's MAC address.

Returns
The Pleora Protocol device's MAC address, in the form aa:bb:cc:dd:ee:ff, where aa through ff are lowercase hexadecimal numbers ranging from 0x00 to 0xff.

◆ GetModuleID()

uint8_t PvDeviceInfoPleoraProtocol::GetModuleID ( ) const

Returns the Module ID of the Pleora Protocol device.

Returns
Module ID.

◆ GetSoftwareMajor()

uint8_t PvDeviceInfoPleoraProtocol::GetSoftwareMajor ( ) const

Major version of the firmware running on the Pleora Protocol device.

Returns
Major version of the firmware.

◆ GetSoftwareMinor()

uint8_t PvDeviceInfoPleoraProtocol::GetSoftwareMinor ( ) const

Minor version of the firmware running on the Pleora Protocol device.

Returns
Minor version of the firmware.

◆ GetSubID()

uint8_t PvDeviceInfoPleoraProtocol::GetSubID ( ) const

Returns the Sub ID of the Pleora Protocol device.

Returns
Sub ID.

◆ GetSubnetMask()

PvString PvDeviceInfoPleoraProtocol::GetSubnetMask ( ) const

Get the Pleora Protocol device's subnet mask.

Returns
The Pleora Protocol device's subnet mask; the GevCurrentSubnetMask feature. For the form, see GetIPAddress.

◆ GetVendorID()

uint8_t PvDeviceInfoPleoraProtocol::GetVendorID ( ) const

Returns the Vendor ID of the Pleora Protocol device.

Returns
Vendor ID.

◆ operator=()

PvDeviceInfoPleoraProtocol & PvDeviceInfoPleoraProtocol::operator= ( const PvDeviceInfoPleoraProtocol 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