voyant_header_wrapper.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
#include "../capnp_wrapper.h"
#include "header.capnp.h"
#include "voyant_version_wrapper.hpp"
#include <cstdint>
#include <string>
 
enum class DeviceClass : uint8_t
{
  Unknown = 0, 
  Mdl = 1,     
  Ldk = 2      
  // Add more classes as we develop additional products
};
 
DeviceClass deviceClassFromDeviceId(const std::string &device_id);
 
uint16_t deviceNumberFromDeviceId(const std::string &device_id);
 
class VoyantHeaderWrapper : public CapnpWrapper<VoyantHeader>
{
private:
  MessageType message_type_ = MessageType::UNKNOWN;
  int64_t timestamp_seconds_ = 0;
  int32_t timestamp_nanoseconds_ = 0;
  uint32_t frame_index_ = 0;
  DeviceClass device_class_ = DeviceClass::Unknown;
  uint16_t device_number_ = 0;
  VoyantVersionWrapper proto_version_;
  VoyantVersionWrapper api_version_;
  VoyantVersionWrapper firmware_version_;
  VoyantVersionWrapper hdl_version_;
 
public:
  VoyantHeaderWrapper() = default;
 
  ~VoyantHeaderWrapper() override = default;
 
  void fromProto(VoyantHeader::Reader reader) override;
 
  void toProto(VoyantHeader::Builder &builder) const override;
 
  void debugString(std::ostream &os) const override;
 
  // Getters
  std::string deviceId() const;
 
  DeviceClass deviceClass() const { return device_class_; }
 
  uint16_t deviceNumber() const { return device_number_; }
 
  MessageType messageType() const { return message_type_; }
 
  int64_t timestampSeconds() const { return timestamp_seconds_; }
 
  int32_t timestampNanoseconds() const { return timestamp_nanoseconds_; }
 
  uint32_t frameIndex() const { return frame_index_; }
 
  const VoyantVersionWrapper &protoVersion() const { return proto_version_; }
 
  VoyantVersionWrapper &protoVersionMut() { return proto_version_; }
 
  const VoyantVersionWrapper &apiVersion() const { return api_version_; }
 
  VoyantVersionWrapper &apiVersionMut() { return api_version_; }
 
  const VoyantVersionWrapper &firmwareVersion() const { return firmware_version_; }
 
  VoyantVersionWrapper &firmwareVersionMut() { return firmware_version_; }
 
  const VoyantVersionWrapper &hdlVersion() const { return hdl_version_; }
 
  VoyantVersionWrapper &hdlVersionMut() { return hdl_version_; }
 
  // Setters
  void setDeviceClass(DeviceClass value) { device_class_ = value; }
 
  void setDeviceNumber(uint16_t value) { device_number_ = value; }
 
  void setMessageType(MessageType value) { message_type_ = value; }
 
  void setTimestampSeconds(int64_t value) { timestamp_seconds_ = value; }
 
  void setTimestampNanoseconds(int32_t value) { timestamp_nanoseconds_ = value; }
 
  void setFrameIndex(uint32_t value) { frame_index_ = value; }
 
  bool setVersion(uint8_t major,
                  uint8_t minor,
                  uint8_t patch,
                  VersionStatus status,
                  VersionComponent component);
};