CbmMustAddress.h

Go to the documentation of this file.

/* Copyright (C) 2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Radoslaw Karabowicz [committer] */
 
#ifndef CBMMUSTADDRESS_H
#define CBMMUSTADDRESS_H 1
 
#include "CbmAddress.h"  // for CbmAddress
 
#ifndef NO_ROOT
#include <Rtypes.h>  // for ClassDef
#endif
 
#include <cstdint>


enum MustElementLevel
{
  kMustSystem,    
  kMustStation,   
  kMustLayer,     
  kMustModule,    
  kMustTube,      
  kMustNofLevels  
};
 


class CbmMustAddress : public CbmAddress {
 
 public:
  static uint32_t GetAddress(int32_t station = 0, int32_t layer = 0, int32_t module = 0, int32_t tube = 0);
 
 
  static uint32_t GetAddress(int32_t* elementIds);
 

  static int32_t GetNofLevels() { return kMustNofLevels; }
 

  static int32_t GetNofBits(int32_t level) { return (level >= 0 && level < kMustNofLevels) ? fgkBits[level] : 0; }
 

  static int32_t GetElementId(uint32_t address, int32_t level)
  {
    return (level >= 0 && level < kMustNofLevels) ? ((address & (fgkMask[level] << fgkShift[level])) >> fgkShift[level])
                                                  : -1;
  }

  static int32_t GetSystemIndex(int32_t address) { return GetElementId(address, kMustSystem); }
  static int32_t GetStationIndex(int32_t address) { return GetElementId(address, kMustStation); }
  static int32_t GetLayerIndex(int32_t address) { return GetElementId(address, kMustLayer); }
  static int32_t GetModuleIndex(int32_t address) { return GetElementId(address, kMustModule); }
  static int32_t GetTubeIndex(int32_t address) { return GetElementId(address, kMustTube); }
 
  static int32_t GetElementAddress(int32_t address, int32_t level)
  {
    int32_t mask = (1 << (CbmMustAddress::fgkShift[level] + CbmMustAddress::fgkBits[level])) - 1;
    return address & mask;
  }

  static void Print();
 

  static uint32_t SetElementId(uint32_t address, int32_t level, int32_t newId);
 
 private:
  static const int32_t fgkBits[kMustNofLevels];

  static const int32_t fgkShift[kMustNofLevels];

  static const int32_t fgkMask[kMustNofLevels];
 
 
#ifndef NO_ROOT
  ClassDef(CbmMustAddress, 1);
#endif
};
 
 
#endif /* CBMMUSTADDRESS_H  */