CbmRichAddress.cxx

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] */

 
#include "CbmRichAddress.h"
 
#include "AlgoFairloggerCompat.h"
#include "CbmDefs.h"
 
#include <cassert>
#include <sstream>
 
int32_t CbmRichAddress::GetAddress(uint32_t camera, uint32_t strip, uint32_t backplane, uint32_t pmt, uint32_t pixel,
                                   uint32_t version)
{
  using namespace Detail;
 
  assert(version <= kCurrentVersion);
 
  // Catch overrun of allowed ranges
  if (camera > static_cast<uint32_t>(kMask[version][static_cast<int32_t>(RichElementLevel::kCamera)])) {
    LOG(error) << "CbmRichAddress::GetAddress: Camera Id " << camera << " exceeds maximum "
               << kMask[version][static_cast<int32_t>(RichElementLevel::kCamera)];
    return 0;
  }
  if (strip > static_cast<uint32_t>(kMask[version][static_cast<int32_t>(RichElementLevel::kStrip)])) {
    LOG(error) << "CbmRichAddress::GetAddress: Strip Id " << strip << " exceeds maximum "
               << kMask[version][static_cast<int32_t>(RichElementLevel::kStrip)];
    return 0;
  }
  if (backplane > static_cast<uint32_t>(kMask[version][static_cast<int32_t>(RichElementLevel::kBackplane)])) {
    LOG(error) << "CbmRichAddress::GetAddress: Backplane Id " << backplane << " exceeds maximum "
               << kMask[version][static_cast<int32_t>(RichElementLevel::kBackplane)];
    return 0;
  }
  if (pmt > static_cast<uint32_t>(kMask[version][static_cast<int32_t>(RichElementLevel::kPmt)])) {
    LOG(error) << "CbmRichAddress::GetAddress: Pmt Id " << pmt << " exceeds maximum "
               << kMask[version][static_cast<int32_t>(RichElementLevel::kPmt)];
    return 0;
  }
  if (pixel > static_cast<uint32_t>(kMask[version][static_cast<int32_t>(RichElementLevel::kPixel)])) {
    LOG(error) << "CbmRichAddress::GetAddress: Pixel Id " << pixel << " exceeds maximum "
               << kMask[version][static_cast<int32_t>(RichElementLevel::kPixel)];
    return 0;
  }
 
  return ToIntegralType(ECbmModuleId::kRich) << kShift[version][static_cast<int32_t>(RichElementLevel::kSystem)]
         | camera << kShift[version][static_cast<int32_t>(RichElementLevel::kCamera)]
         | strip << kShift[version][static_cast<int32_t>(RichElementLevel::kStrip)]
         | backplane << kShift[version][static_cast<int32_t>(RichElementLevel::kBackplane)]
         | pmt << kShift[version][static_cast<int32_t>(RichElementLevel::kPmt)]
         | pixel << kShift[version][static_cast<int32_t>(RichElementLevel::kPixel)] | version << kVersionShift;
}
 
int32_t CbmRichAddress::GetMotherAddress(int32_t address, int32_t level)
{
  using namespace Detail;
  if (!(level >= static_cast<int32_t>(RichElementLevel::kSystem)
        && level < static_cast<int32_t>(RichElementLevel::kNumLevels))) {
    throw std::out_of_range(std::string("CbmRichAddress::GetMotherAddress: Illegal element level ")
                            + std::to_string(level));
    return 0;
  }
  if (level == static_cast<int32_t>(RichElementLevel::kNumLevels) - 1) return address;
  uint32_t version  = GetVersion(address);
  int32_t motherAdd = (address & ((1 << kShift[version][level + 1]) - 1));
  motherAdd         = motherAdd | (version << kVersionShift);
  return motherAdd;
}
 
uint32_t CbmRichAddress::GetElementId(int32_t address, int32_t level)
{
  using namespace Detail;
  if (!(level >= static_cast<int32_t>(RichElementLevel::kSystem)
        && level < static_cast<int32_t>(RichElementLevel::kNumLevels))) {
    throw std::out_of_range(std::string("CbmRichAddress::GetElementId: Illegal element level ")
                            + std::to_string(level));
    return 0;
  }
  uint32_t version = GetVersion(address);
  return (address & (kMask[version][level] << kShift[version][level])) >> kShift[version][level];
}
 
uint32_t CbmRichAddress::GetSystemId(int32_t address)
{
  return GetElementId(address, static_cast<uint32_t>(RichElementLevel::kSystem));
}
 
uint32_t CbmRichAddress::GetVersion(int32_t address)
{
  return uint32_t((address & (kVersionMask << kVersionShift)) >> kVersionShift);
}
 
int32_t CbmRichAddress::SetElementId(int32_t address, int32_t level, uint32_t newId)
{
  using namespace Detail;
  if (!(level >= static_cast<int32_t>(RichElementLevel::kSystem)
        && level < static_cast<int32_t>(RichElementLevel::kNumLevels))) {
    throw std::out_of_range(std::string("CbmRichAddress::SetElementId: Illegal element level ")
                            + std::to_string(level));
    return 0;
  }
  uint32_t version = GetVersion(address);
  uint32_t maxId   = (1 << kBits[version][level]) - 1;
  if (newId > maxId) {
    LOG(fatal) << "CbmRichAddress::SetElementId: Id " << newId << " for RICH level " << level << " exceeds maximum "
               << maxId;
    return 0;
  }
  return (address & (~(kMask[version][level] << kShift[version][level]))) | (newId << kShift[version][level]);
}
 
std::string CbmRichAddress::ToString(int32_t address)
{
  std::stringstream ss;
 
  ss << "RichAddress: address " << address << " (version " << GetVersion(address) << ")"
     << ": system " << GetElementId(address, static_cast<int32_t>(RichElementLevel::kSystem)) << ", camera "
     << GetElementId(address, static_cast<int32_t>(RichElementLevel::kCamera)) << ", strip "
     << GetElementId(address, static_cast<int32_t>(RichElementLevel::kStrip)) << ", photo detector "
     << GetElementId(address, static_cast<int32_t>(RichElementLevel::kBackplane)) << ", pmt "
     << GetElementId(address, static_cast<int32_t>(RichElementLevel::kPmt)) << ", pixel "
     << GetElementId(address, static_cast<int32_t>(RichElementLevel::kPixel));
  return ss.str();
}