InterfaceParams.hpp

Go to the documentation of this file.

// Copyright (c) 2026 EduArt Robotik GmbH

 
#pragma once
 
#include <string>
 
#include "sensorring/platform/SensorringExport.hpp"
 
namespace eduart {
 
namespace sensorring {
 
namespace com {

struct SENSORRING_EXPORT InterfaceParams {
  virtual ~InterfaceParams() = default;

  std::string name;
 
protected:
  InterfaceParams() = default;
  explicit InterfaceParams(std::string name)
      : name(std::move(name)) {}
};

struct SENSORRING_EXPORT CanParams : InterfaceParams {

  bool respond_with_brs = false;

  unsigned int data_bitrate = 0;

  float data_sample_point = 0.0f;

  void send_with_brs(bool enable) { _send_with_brs = enable; }

  bool send_with_brs() const { return _send_with_brs; }
 
  CanParams() = default;
  CanParams(std::string interface_name, bool respond_with_brs = false, unsigned int data_bitrate = 0, float data_sample_point = 0.0f)
      : InterfaceParams(std::move(interface_name))
      , respond_with_brs(respond_with_brs)
      , data_bitrate(data_bitrate)
      , data_sample_point(data_sample_point) {}
 
private:
  bool _send_with_brs = false;
};

struct SENSORRING_EXPORT SocketCanParams : CanParams {
 
  SocketCanParams() = default;
  SocketCanParams(std::string interface_name, bool respond_with_brs = false, unsigned int data_bitrate = 0, float data_sample_point = 0.0f)
      : CanParams(std::move(interface_name), respond_with_brs, data_bitrate, data_sample_point) {}
};

struct SENSORRING_EXPORT UsbTingoParams : CanParams {
 
  UsbTingoParams() = default;
  UsbTingoParams(std::string interface_name, bool respond_with_brs = false, unsigned int data_bitrate = 0, float data_sample_point = 0.0f)
      : CanParams(std::move(interface_name), respond_with_brs, data_bitrate, data_sample_point) {}
};
 
} // namespace com
 
} // namespace sensorring
 
} // namespace eduart