ItalaApiNET  1.3.3
Public Attributes | List of all members
Itala.DeviceInfo Struct Reference

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. More...

Public Attributes

string Id
 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 tring isn't regulated by any standard and its format and content are implementation specific. More...
 
string Vendor
 Name of the device vendor. More...
 
string Model
 Model of the device. More...
 
string DisplayName
 User readable name of the device. More...
 
string UserDefinedName
 Name of the device defined by the user, when available. More...
 
string SerialNumber
 Serial number of the device. More...
 
string Version
 Version of the physical device. More...
 
DeviceAccessStatus AccessStatus
 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 is the responsibility of the user to check if a device is currently available for initialization before using it. More...
 
UInt32 IpAddress
 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. More...
 
UInt32 SubnetMask
 Subnet mask configured on the device in the same format described in IpAddress. More...
 
UInt32 DefaultGateway
 Default gateway configured on the device according to the same format described in IpAddress. More...
 
UInt64 MacAddress
 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-hexadecimal notation. More...
 
InterfaceInfo InterfaceInfo
 InterfaceInfo instance of the interface under which the device is connected and enumerated. More...
 

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 Data Documentation

◆ Id

string Itala.DeviceInfo.Id

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 tring isn't regulated by any standard and its format and content are implementation specific.

◆ Vendor

string Itala.DeviceInfo.Vendor

Name of the device vendor.

◆ Model

string Itala.DeviceInfo.Model

Model of the device.

◆ DisplayName

string Itala.DeviceInfo.DisplayName

User readable name of the device.

◆ UserDefinedName

string Itala.DeviceInfo.UserDefinedName

Name of the device defined by the user, when available.

◆ SerialNumber

string Itala.DeviceInfo.SerialNumber

Serial number of the device.

◆ Version

string Itala.DeviceInfo.Version

Version of the physical device.

◆ AccessStatus

DeviceAccessStatus Itala.DeviceInfo.AccessStatus

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 is the responsibility of the user to check if a device is currently available for initialization before using it.

◆ IpAddress

UInt32 Itala.DeviceInfo.IpAddress

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.

◆ SubnetMask

UInt32 Itala.DeviceInfo.SubnetMask

Subnet mask configured on the device in the same format described in IpAddress.

◆ DefaultGateway

UInt32 Itala.DeviceInfo.DefaultGateway

Default gateway configured on the device according to the same format described in IpAddress.

◆ MacAddress

UInt64 Itala.DeviceInfo.MacAddress

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-hexadecimal notation.

◆ InterfaceInfo

InterfaceInfo Itala.DeviceInfo.InterfaceInfo

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


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