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

Public Member Functions

GenICam::gcstring ID () const
 
GenICam::gcstring Vendor () const
 
GenICam::gcstring Model () const
 
GenICam::gcstring DisplayName () const
 
GenICam::gcstring UserDefinedName () const
 
GenICam::gcstring SerialNumber () const
 
GenICam::gcstring Version () const
 
DeviceAccessStatus AccessStatus () const
 
uint32_t IpAddress () const
 
uint32_t SubnetMask () const
 
uint32_t DefaultGateway () const
 
uint64_t MacAddress () const
 
InterfaceInfo ParentInterfaceInfo () const
 

Detailed Description

This class stores information about a device and represents its identity. When an enumeration (also known as "discovery") is performed via the ISystem interface, a list of DeviceInfo is returned as result. To initialize and use a particular connected device, the user must pass the corresponding DeviceInfo instance to the ISystem interface.

Member Function Documentation

◆ ID()

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

Get the unique ID of the device. The ID of a discovered device is a GenICam::gcstring assigned and used by the internal transport layer to uniquely identify the device 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 device

◆ Vendor()

GenICam::gcstring Itala::DeviceInfo::Vendor ( ) const

Get a string containing the name of the device vendor.

Returns
Name of the device vendor

◆ Model()

GenICam::gcstring Itala::DeviceInfo::Model ( ) const

Get a string containing the model of the device.

Returns
Model of the device

◆ DisplayName()

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

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

Returns
Name of the device

◆ UserDefinedName()

GenICam::gcstring Itala::DeviceInfo::UserDefinedName ( ) const

Get a string containing the name of the device defined by the user, when available.

Returns
User-defined name of the device

◆ SerialNumber()

GenICam::gcstring Itala::DeviceInfo::SerialNumber ( ) const

Get a string containing the serial number of the device.

Returns
Serial number of the device

◆ Version()

GenICam::gcstring Itala::DeviceInfo::Version ( ) const

Get a string containing the version of the physical device.

Returns
Version of the device

◆ AccessStatus()

DeviceAccessStatus Itala::DeviceInfo::AccessStatus ( ) const

Get the accessibility status of the device. Depending on its network configuration or internal state (e.g. if already in use by another process) its accessibility may change. It's responsibility of the user to check if a device is currently available for initialization before using it.

Returns
access status of the device.

◆ IpAddress()

uint32_t Itala::DeviceInfo::IpAddress ( ) const

Get an unsigned 32 bit integer containing the IP address of the device in host 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 device as integer in host byte order.

◆ SubnetMask()

uint32_t Itala::DeviceInfo::SubnetMask ( ) const

Get the subnet mask configured on the device in the same format described in IpAddress().

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

◆ DefaultGateway()

uint32_t Itala::DeviceInfo::DefaultGateway ( ) const

Get the default gateway configured on the device according with the same format described in IpAddress().

Returns
Default gateway of the device as raw integer in host byte order.
See also
IpAddress()

◆ MacAddress()

uint64_t Itala::DeviceInfo::MacAddress ( ) const

Get an unsigned 64 bit integer containing the mac address of the device 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 device as integer in host byte order.

◆ ParentInterfaceInfo()

InterfaceInfo Itala::DeviceInfo::ParentInterfaceInfo ( ) const

Get the InterfaceInfo instance of the interface under which the device is connected and enumerated.

Returns
Info object of the interface which owns the device.

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