DeviceInfo.h

Go to the documentation of this file.

// Copyright (c) 2025 Optris GmbH Co. KG

 
#pragma once
 
#include <string>
#include <ostream>
 
#include "otcsdk/Api.h"
#include "otcsdk/common/DeviceType.h"
#include "otcsdk/communication/net/IpAddress.h"
#include "otcsdk/communication/net/Port.h"
 
 
namespace optris
{

class DeviceInfo
{
public:
  OTC_SDK_API DeviceInfo() noexcept;
 

  OTC_SDK_API static DeviceType determineDeviceType(unsigned short hardwareRevision, unsigned short firmwareRevision) noexcept;
 

  OTC_SDK_API void setSerialNumber(unsigned long serialNumber) noexcept;

  OTC_SDK_API unsigned long getSerialNumber() const noexcept;

  OTC_SDK_API void setConnectionInterface(const std::string& connectionInterface) noexcept;

  OTC_SDK_API const std::string& getConnectionInterface() const noexcept;

  OTC_SDK_API void setIpAddress(const IpAddress& ipAddress) noexcept;

  OTC_SDK_API const IpAddress& getIpAddress() const noexcept;

  OTC_SDK_API void setPort(const Port& port) noexcept;

  OTC_SDK_API const Port& getPort() const noexcept;

  OTC_SDK_API DeviceType getDeviceType() const noexcept;

  OTC_SDK_API void setRevisions(unsigned short hardware, unsigned short firmware) noexcept;

  OTC_SDK_API unsigned short getHardwareRevision() const noexcept;

  OTC_SDK_API unsigned short getFirmwareRevision() const noexcept;
 

  OTC_SDK_API DeviceInfo clone() const noexcept;
 

  OTC_SDK_API bool operator==(const DeviceInfo& rhs) const noexcept;
  OTC_SDK_API bool operator!=(const DeviceInfo& rhs) const noexcept;
  OTC_SDK_API bool operator<(const DeviceInfo& rhs) const noexcept;
 
 
private:
  unsigned long _serialNumber;
 
  std::string _connectionInterface;
 
  IpAddress _ipAddress;
  Port      _port;
 
  DeviceType _deviceType;
 
  unsigned short _hardwareRevision;
  unsigned short _firmwareRevision;
};
 
 
// Inline implementations
inline void DeviceInfo::setSerialNumber(unsigned long serialNumber) noexcept
{
  _serialNumber = serialNumber;
}
 
inline unsigned long DeviceInfo::getSerialNumber() const noexcept
{
  return _serialNumber;
}
 
inline void DeviceInfo::setConnectionInterface(const std::string& connectionInterface) noexcept
{
  _connectionInterface = connectionInterface;
}
 
inline const std::string& DeviceInfo::getConnectionInterface() const noexcept
{
  return _connectionInterface;
}
 
inline void DeviceInfo::setIpAddress(const IpAddress& ipAddress) noexcept
{
  _ipAddress = ipAddress;
}
 
inline const IpAddress& DeviceInfo::getIpAddress() const noexcept
{
  return _ipAddress;
}
 
inline void DeviceInfo::setPort(const Port& port) noexcept
{
  _port = port;
}
 
inline const Port& DeviceInfo::getPort() const noexcept
{
  return _port;
}
 
inline DeviceType DeviceInfo::getDeviceType() const noexcept
{
  return _deviceType;
}
 
inline unsigned short DeviceInfo::getHardwareRevision() const noexcept
{
  return _hardwareRevision;
}
 
inline unsigned short DeviceInfo::getFirmwareRevision() const noexcept
{
  return _firmwareRevision;
}
 
inline DeviceInfo DeviceInfo::clone() const noexcept
{
  return DeviceInfo{*this};
}
 
inline bool DeviceInfo::operator==(const DeviceInfo& rhs) const noexcept
{
  return _serialNumber == rhs._serialNumber;
}
 
inline bool DeviceInfo::operator!=(const DeviceInfo& rhs) const noexcept
{
  return _serialNumber != rhs._serialNumber;
}
 
inline bool DeviceInfo::operator<(const DeviceInfo& rhs) const noexcept
{
  return _serialNumber < rhs._serialNumber;
}
 
} // namespace optris