EnumerationInformation.hpp

Go to the documentation of this file.

// Copyright (c) 2026 EduArt Robotik GmbH

 
#pragma once
 
#include <cstdint>
#include <iostream>
#include <string>
#include <vector>
 
#include "sensorring/board/SensorBoardType.hpp"
#include "sensorring/device/DeviceType.hpp"
#include "sensorring/platform/SensorringExport.hpp"
 
namespace eduart {
 
namespace sensorring {

struct SENSORRING_EXPORT Version {
  unsigned int major = 0;
  unsigned int minor = 0;
  unsigned int patch = 0;

  std::string toString() const;

  friend std::ostream& operator<<(std::ostream& os, const Version& v) noexcept;

  bool operator==(const Version& other) const noexcept;

  bool operator<(const Version& other) const noexcept;
};

struct SENSORRING_EXPORT CommitHash {
  std::uint32_t hash = 0;

  std::string toString() const;

  friend std::ostream& operator<<(std::ostream& os, const CommitHash& ch) noexcept;

  bool operator==(const CommitHash& other) const noexcept;

  bool operator=(const std::uint32_t& other) noexcept;
};
 
namespace board {

enum class ConnectionState {
  Undefined,
  Connected,
  Unconnected
};

enum class ConfigurationState {
  Undefined,
  Configured,
  Unconfigured
};

SENSORRING_EXPORT std::string toString(ConnectionState state);

SENSORRING_EXPORT std::string toString(ConfigurationState state);

SENSORRING_EXPORT std::ostream& operator<<(std::ostream& os, const ConnectionState state) noexcept;

SENSORRING_EXPORT std::ostream& operator<<(std::ostream& os, const ConfigurationState state) noexcept;

struct SENSORRING_EXPORT EnumerationInformation {
  unsigned int idx = 0;

  Version version = {};

  CommitHash hash = {};

  SensorBoardType type = SensorBoardType::Undefined;

  std::uint16_t device_options = 0;

  std::vector<device::DeviceType> devices;

  ConnectionState state = ConnectionState::Undefined;

  ConfigurationState config_state = ConfigurationState::Undefined;

  std::vector<device::DeviceType> configured_devices;

  bool isUndefined() const noexcept;

  static EnumerationInformation fromBuffer(const std::vector<uint8_t>& buffer);

  bool hasDevice(device::DeviceType type) const noexcept;

  bool operator==(unsigned int other) const noexcept;

  bool operator==(const EnumerationInformation& other) const noexcept;

  bool operator<(const EnumerationInformation& other) const noexcept;

  std::string toString() const;
};
 
} // namespace board
 
} // namespace sensorring
 
} // namespace eduart