CbmRichAddress.h

Go to the documentation of this file.

/* Copyright (C) 2024 Justus-Liebig-Universitaet Giessen, Giessen
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Martin Beyer [committer] */

 
#pragma once
 
#include <cstdint>
#include <string>

namespace CbmRichAddress
{
  enum class RichElementLevel
  {
    kSystem,
    kCamera,
    kStrip,
    kBackplane,
    kPmt,
    kPixel,
    kNumLevels
  };
 
  inline constexpr uint32_t kCurrentVersion = 0;
 
  // --- These values are not to be changed if backward compatibility
  // --- shall be maintained.
  inline constexpr int32_t kVersionSize  = 4;   // Bits for version number
  inline constexpr int32_t kVersionShift = 28;  // First bit for version number
  inline constexpr int32_t kVersionMask  = (1 << kVersionSize) - 1;
 
  namespace Detail
  {
    // -----    Definition of address bit field   ------------------------------
    inline constexpr uint16_t kBits[kCurrentVersion + 1][static_cast<uint32_t>(RichElementLevel::kNumLevels)] = {
 
      // Version 0
      {
        4,  // system
        1,  // camera
        4,  // strip
        3,  // backplane
        3,  // pmt
        6   // pixel
      }};
    // -------------------------------------------------------------------------
 
    // -----    Bit shifts -----------------------------------------------------
    inline constexpr int32_t kShift[kCurrentVersion + 1][static_cast<uint32_t>(RichElementLevel::kNumLevels)] = {
      {0, kShift[0][0] + kBits[0][0], kShift[0][1] + kBits[0][1], kShift[0][2] + kBits[0][2],
       kShift[0][3] + kBits[0][3], kShift[0][4] + kBits[0][4]}};
    // -------------------------------------------------------------------------
 
    // -----    Bit masks  -----------------------------------------------------
    inline constexpr int32_t kMask[kCurrentVersion + 1][static_cast<uint32_t>(RichElementLevel::kNumLevels)] = {
      {(1 << kBits[0][0]) - 1, (1 << kBits[0][1]) - 1, (1 << kBits[0][2]) - 1, (1 << kBits[0][3]) - 1,
       (1 << kBits[0][4]) - 1, (1 << kBits[0][5]) - 1}};
    // -------------------------------------------------------------------------
 
 
  }  // namespace Detail

  int32_t GetAddress(uint32_t camera = 0, uint32_t strip = 0, uint32_t backplane = 0, uint32_t pmt = 0,
                     uint32_t pixel = 0, uint32_t version = kCurrentVersion);

  int32_t GetMotherAddress(int32_t address, int32_t level);

  uint32_t GetElementId(int32_t address, int32_t level);

  uint32_t GetSystemId(int32_t address);

  uint32_t GetVersion(int32_t address);

  int32_t SetElementId(int32_t address, int32_t level, uint32_t newId);

  std::string ToString(int32_t address);
 
}  // namespace CbmRichAddress