ItalaApi
1.3.3
|
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 |
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.
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.
GenICam::gcstring Itala::DeviceInfo::Vendor | ( | ) | const |
Get a string containing the name of the device vendor.
GenICam::gcstring Itala::DeviceInfo::Model | ( | ) | const |
Get a string containing the model of the device.
GenICam::gcstring Itala::DeviceInfo::DisplayName | ( | ) | const |
Get a string containing the user readable name of the device.
GenICam::gcstring Itala::DeviceInfo::UserDefinedName | ( | ) | const |
Get a string containing the name of the device defined by the user, when available.
GenICam::gcstring Itala::DeviceInfo::SerialNumber | ( | ) | const |
Get a string containing the serial number of the device.
GenICam::gcstring Itala::DeviceInfo::Version | ( | ) | const |
Get a string containing the version of the physical device.
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.
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.
uint32_t Itala::DeviceInfo::SubnetMask | ( | ) | const |
Get the subnet mask configured on the device in the same format described in IpAddress().
uint32_t Itala::DeviceInfo::DefaultGateway | ( | ) | const |
Get the default gateway configured on the device according with the same format described in IpAddress().
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.
InterfaceInfo Itala::DeviceInfo::ParentInterfaceInfo | ( | ) | const |
Get the InterfaceInfo instance of the interface under which the device is connected and enumerated.