Port.h

Go to the documentation of this file.

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

 
#pragma once
 
#include <cstdint>
#include <string>
#include <ostream>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
 
 
namespace optris
{

class Port
{
public:
  using Number = std::uint16_t;
 

  Port() noexcept;

  Port(Number number) noexcept;

  Port(const std::string& port);
 

  void reset() noexcept;

  void setNumber(Number number) noexcept;

  Number getNumber() const noexcept;

  OTC_SDK_API void setFromString(const std::string& port) noexcept(false);

  OTC_SDK_API std::string toString() const noexcept;
 
  
  bool operator==(const Port& rhs) const noexcept;
  bool operator!=(const Port& rhs) const noexcept;
  bool operator<(const Port& rhs) const noexcept;
 
 
private:
  Number _number;
};
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const Port& port) noexcept;
 
 
// Inline implementations
inline Port::Port() noexcept
  : _number{0}
{ }
 
inline Port::Port(Number number) noexcept
  : _number{number}
{ }
 
inline Port::Port(const std::string& port)
{
  setFromString(port);
}
 
inline void Port::reset() noexcept
{
  _number = 0;
}
 
inline void Port::setNumber(Number number) noexcept
{
  _number = number;
}
 
inline Port::Number Port::getNumber() const noexcept
{
  return _number;
}
 
inline bool Port::operator==(const Port& rhs) const noexcept
{
  return _number == rhs._number;
}
 
inline bool Port::operator!=(const Port& rhs) const noexcept
{
  return _number != rhs._number;
}
 
inline bool Port::operator<(const Port& rhs) const noexcept
{
  return _number < rhs._number;
}
 
} // namespace optris