voyant_version_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 <cstdint>
#include <string>
 
enum class VersionComponent : uint8_t
{
  Unknown = 0x0,  
  Proto = 0x1,    
  Api = 0x2,      
  Firmware = 0x3, 
  Hdl = 0x4       
};
 
enum class VersionStatus : uint8_t
{
  Unknown = 0x0,          
  Development = 0x1,      
  Alpha = 0x2,            
  Beta = 0x3,             
  ReleaseCandidate = 0x4, 
  Stable = 0x5,           
  Deprecated = 0x6,       
  Legacy = 0x7            
};
 
class VoyantVersionWrapper : public CapnpWrapper<VoyantVersion>
{
private:
  uint8_t major_ = 0;                                      
  uint8_t minor_ = 0;                                      
  uint8_t patch_ = 0;                                      
  VersionStatus status_ = VersionStatus::Unknown;          
  VersionComponent component_ = VersionComponent::Unknown; 
 
public:
  VoyantVersionWrapper() = default;
 
  ~VoyantVersionWrapper() override = default;
 
  VoyantVersionWrapper(uint8_t major,
                       uint8_t minor,
                       uint8_t patch,
                       VersionStatus status,
                       VersionComponent component);
 
  static VoyantVersionWrapper fromU32Hash(uint32_t hash);
 
  void fromProto(VoyantVersion::Reader reader) override;
 
  void toProto(VoyantVersion::Builder &builder) const override;
 
  void debugString(std::ostream &os) const override;
 
  // Getters
  uint8_t major() const { return major_; }
 
  uint8_t minor() const { return minor_; }
 
  uint8_t patch() const { return patch_; }
 
  VersionStatus status() const { return status_; }
 
  VersionComponent component() const { return component_; }
 
  // Setters
  void setMajor(uint8_t major) { major_ = major; }
 
  void setMinor(uint8_t minor) { minor_ = minor; }
 
  void setPatch(uint8_t patch) { patch_ = patch; }
 
  void setStatus(VersionStatus status) { status_ = status; }
 
  void setComponent(VersionComponent component) { component_ = component; }
 
  // Helper methods
  uint8_t flags() const;
 
  void setFlags(uint8_t flags);
 
  std::string toString() const;
 
  std::string toVerboseString() const;
 
  uint32_t toU32Hash() const;
 
  bool isCompatible(const VoyantVersionWrapper &other) const;
};