Pleora Technologies Inc. eBUS SDK v6.2.15.6244 API



Public Member Functions | List of all members
PvDeviceInfoGEV Class Reference

Information identifying a GigE Vision device. More...

Public Member Functions

 PvDeviceInfoGEV ()
 Constructor.
 
virtual ~PvDeviceInfoGEV ()
 Destructor.
 
PvDeviceInfoGEV & operator= (const PvDeviceInfoGEV &aFrom)
 Equal operator: copies the object. More...
 
PvString GetMACAddress () const
 Get the GigE Vision device's MAC address. More...
 
PvString GetIPAddress () const
 Get the GigE Vision device's current IP address. More...
 
PvString GetDefaultGateway () const
 Get the GigE Vision device's default gateway. More...
 
PvString GetSubnetMask () const
 Get the GigE Vision device's subnet mask. More...
 
uint32_t GetGEVVersion () const
 Get the GigE Vision device's network protocol version. More...
 
PvString GetIPConfigOptionsString () const
 Get the GigE Vision device's IP config options. More...
 
PvString GetIPConfigCurrentString () const
 Get the GigE Vision device's current IP config. More...
 
bool IsLLAAvailable () const
 Check if LLA is one of the IP config options for the GigE Vision device. More...
 
bool IsDHCPAvailable () const
 Check if DHCP is one of the IP config options for the GigE Vision device. More...
 
bool IsPersistentAvailable () const
 Check if Persistent_IP is one of the IP config options for the GigE Vision device. More...
 
bool IsPRAvailable () const
 Check if PAUSE_reception is one of the IP config options for the GigE Vision device. More...
 
bool IsPGAvailable () const
 Check if PAUSE_generation is one of the IP config options for the GigE Vision device. More...
 
bool IsLLAEnabled () const
 Check if LLA is in current IP config for the GigE Vision device. More...
 
bool IsDHCPEnabled () const
 Check if DHCP is in current IP config for the GigE Vision device. More...
 
bool IsPersistentEnabled () const
 Check if Persistent_IP is in current IP config for the GigE Vision device. More...
 
bool IsPREnabled () const
 Check if PAUSE_reception is in current IP config for the GigE Vision device. More...
 
bool IsPGEnabled () const
 Check if PAUSE_generation is in current IP config for the GigE Vision device. More...
 
- Public Member Functions inherited from PvDeviceInfo
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...
 

Detailed Description

Information identifying a GigE Vision device.

Member Function Documentation

PvString PvDeviceInfoGEV::GetDefaultGateway ( ) const

Get the GigE Vision device's default gateway.

Returns
The GigE Vision device's default gateway; the GevCurrentDefaultGateway feature. For the form, see GetIPAddress.
uint32_t PvDeviceInfoGEV::GetGEVVersion ( ) const

Get the GigE Vision device's network protocol version.

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

Returns
The GigE Vision device's network protocol version.
PvString PvDeviceInfoGEV::GetIPAddress ( ) const

Get the GigE Vision device's current IP address.

Returns
The GigE Vision 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.
PvString PvDeviceInfoGEV::GetIPConfigCurrentString ( ) const

Get the GigE Vision device's current IP config.

Returns
The GigE Vision device's current IP config; The form is LLA(L)DHCP(D)Persistent_IP(P)PAUSE_reception(PR)PAUSE_generation(PG), where each represents device's currently set IP configuration.
PvString PvDeviceInfoGEV::GetIPConfigOptionsString ( ) const

Get the GigE Vision device's IP config options.

Returns
The GigE Vision device's IP config options; The form is LLA(L)DHCP(D)Persistent_IP(P)PAUSE_reception(PR)PAUSE_generation(PG), where each represents device's possible IP configuration options.
PvString PvDeviceInfoGEV::GetMACAddress ( ) const

Get the GigE Vision device's MAC address.

Returns
The GigE Vision 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.
PvString PvDeviceInfoGEV::GetSubnetMask ( ) const

Get the GigE Vision device's subnet mask.

Returns
The GigE Vision device's subnet mask; the GevCurrentSubnetMask feature. For the form, see GetIPAddress.
bool PvDeviceInfoGEV::IsDHCPAvailable ( ) const

Check if DHCP is one of the IP config options for the GigE Vision device.

Returns
True, if DHCP is an option, False otherwise.
bool PvDeviceInfoGEV::IsDHCPEnabled ( ) const

Check if DHCP is in current IP config for the GigE Vision device.

Returns
True, if DHCP is in current IP config, False otherwise.
bool PvDeviceInfoGEV::IsLLAAvailable ( ) const

Check if LLA is one of the IP config options for the GigE Vision device.

Returns
True, if LLA is an option, False otherwise.
bool PvDeviceInfoGEV::IsLLAEnabled ( ) const

Check if LLA is in current IP config for the GigE Vision device.

Returns
True, if LLA is in current IP config, False otherwise.
bool PvDeviceInfoGEV::IsPersistentAvailable ( ) const

Check if Persistent_IP is one of the IP config options for the GigE Vision device.

Returns
True, if Persistent_IP is an option, False otherwise.
bool PvDeviceInfoGEV::IsPersistentEnabled ( ) const

Check if Persistent_IP is in current IP config for the GigE Vision device.

Returns
True, if Persistent_IP is in current IP config, False otherwise.
bool PvDeviceInfoGEV::IsPGAvailable ( ) const

Check if PAUSE_generation is one of the IP config options for the GigE Vision device.

Returns
True, if PAUSE_generation is an option, False otherwise.
bool PvDeviceInfoGEV::IsPGEnabled ( ) const

Check if PAUSE_generation is in current IP config for the GigE Vision device.

Returns
True, if PAUSE_generation is in current IP config, False otherwise.
bool PvDeviceInfoGEV::IsPRAvailable ( ) const

Check if PAUSE_reception is one of the IP config options for the GigE Vision device.

Returns
True, if PAUSE_reception is an option, False otherwise.
bool PvDeviceInfoGEV::IsPREnabled ( ) const

Check if PAUSE_reception is in current IP config for the GigE Vision device.

Returns
True, if PAUSE_reception is in current IP config, False otherwise.
PvDeviceInfoGEV & PvDeviceInfoGEV::operator= ( const PvDeviceInfoGEV &  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-2022 Pleora Technologies Inc.
www.pleora.com