|
libvisiontransfer
10.0.0
|
Aggregates information about a discovered device. More...
#include <visiontransfer/deviceinfo.h>
Public Types | |
| enum | DeviceModel { SCENESCAN, SCENESCAN_PRO, SCARLET } |
| enum | NetworkProtocol { PROTOCOL_TCP, PROTOCOL_UDP } |
Public Member Functions | |
| DeviceInfo () | |
| Constructs an empty object with default information. More... | |
| DeviceInfo (const char *ip, NetworkProtocol protocol, const char *fwVersion, DeviceModel model, bool compatible) | |
| Constructs an object by initializing all members with data from the given parameters. More... | |
| DeviceInfo (const char *ip, NetworkProtocol protocol, const char *fwVersion, DeviceModel model, bool compatible, const DeviceStatus &status) | |
| Construct DeviceInfo with pre-initialized DeviceStatus field, for received health reports. More... | |
| std::string | getIpAddress () const |
| Gets the IP address of the device. More... | |
| NetworkProtocol | getNetworkProtocol () const |
| Gets the network protocol of the device. More... | |
| std::string | getFirmwareVersion () const |
| Gets the firmware version of the device. More... | |
| DeviceModel | getModel () const |
| Gets the model identifier of the discovered device. More... | |
| DeviceStatus | getStatus () const |
| Return the status / health as reported by the device. More... | |
| bool | isCompatible () const |
| Returns true if the device is compatible with this API version. More... | |
| std::string | toString () const |
| Converts this object to a printable string. More... | |
| bool | operator== (const DeviceInfo &other) const |
| Comparison operator for comparing two DeviceInfo objects. More... | |
Aggregates information about a discovered device.
Definition at line 47 of file deviceinfo.h.
|
inline |
Constructs an empty object with default information.
Definition at line 63 of file deviceinfo.h.
|
inline |
Constructs an object by initializing all members with data from the given parameters.
| ip | IP address of the discovered device. |
| protocol | Network protocol of the discovered device. |
| fwVersion | Firmware version as string. |
| model | Model of the discovered device |
| compatible | Indicates if the device is compatible with this API version. |
Definition at line 78 of file deviceinfo.h.
|
inline |
Construct DeviceInfo with pre-initialized DeviceStatus field, for received health reports.
Definition at line 87 of file deviceinfo.h.
|
inline |
Gets the firmware version of the device.
A firmware version string typically consists of a major, minor and patch version, like for example "1.2.34". For special firmware releases, however, the firmware string might deviate.
Definition at line 115 of file deviceinfo.h.
|
inline |
Gets the IP address of the device.
Definition at line 97 of file deviceinfo.h.
|
inline |
Gets the model identifier of the discovered device.
Currently supported models are SCENESCAN, SCENESCAN_PRO and SCARLET.
Definition at line 124 of file deviceinfo.h.
|
inline |
Gets the network protocol of the device.
Possible network protocols are PROTOCOL_TCP or PROTOCOL_UDP.
Definition at line 105 of file deviceinfo.h.
|
inline |
Return the status / health as reported by the device.
Definition at line 129 of file deviceinfo.h.
|
inline |
Returns true if the device is compatible with this API version.
Definition at line 135 of file deviceinfo.h.
|
inline |
Comparison operator for comparing two DeviceInfo objects.
Definition at line 159 of file deviceinfo.h.
|
inline |
Converts this object to a printable string.
All information is concatenated into a readable string, which can for example be printed to a terminal.
Definition at line 143 of file deviceinfo.h.