ItalaApi  1.3.3
Public Member Functions | List of all members
Itala::InterfaceInfo Class Reference

Public Member Functions

GenICam::gcstring ID () const
 
GenICam::gcstring DisplayName () const
 
uint32_t IpAddress () const
 
uint64_t MacAddress () const
 
uint32_t SubnetMask () const
 

Detailed Description

This class stores information about an available interface and represents its identity. When an enumeration is performed via the ISystem interface, a list of InterfaceInfo is returned as result. To enumerate the available devices under a specific interface, the user must pass the corresponding InterfaceInfo instance to the dedicated ISystem::EnumerateDevices function.

Member Function Documentation

◆ ID()

GenICam::gcstring Itala::InterfaceInfo::ID ( ) const

Get the unique ID of the interface. The ID of an interface is a GenICam::gcstring assigned and used by the internal transport layer to uniquely identify the interface in the current execution context. The ID string isn't regulated by any standard and its format and content are implementation specific.

Returns
Unique ID of the interface

◆ DisplayName()

GenICam::gcstring Itala::InterfaceInfo::DisplayName ( ) const

Get a string containing the user readable name of the interface.

Returns
Name of the interface

◆ IpAddress()

uint32_t Itala::InterfaceInfo::IpAddress ( ) const

Get an unsigned 32 bit integer containing the IP address of the interface in host byte order. For instance, the value 0xC0A8012A represents the IP address 192.168.1.42 in IPv4 dotted-decimal notation.

  • 0xC0 = 192
  • 0xA8 = 168
  • 0x01 = 1
  • 0x2A = 42
Returns
IP address of the interface as integer in host byte order.

◆ MacAddress()

uint64_t Itala::InterfaceInfo::MacAddress ( ) const

Get an unsigned 64 bit integer containing the mac address of the interface in host byte order. A 64 bit integer is required since the MAC address is 6 bytes long. For instance, the value 0x0000885FE8200001 represents the mac address 88:5f:e8:20:00:01 in colon-heaxadecimal notation.

Returns
MAC address of the integer as integer in host byte order.

◆ SubnetMask()

uint32_t Itala::InterfaceInfo::SubnetMask ( ) const

Get the subnet mask of the interface in the same format described in IpAddress().

Returns
Subnet mask of the device as integer in host byte order.
See also
IpAddress()

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