DsElecId.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef O2_MCH_RAW_ELECMAP_DS_ELEC_ID_H
#define O2_MCH_RAW_ELECMAP_DS_ELEC_ID_H
 
#include <cstdint>
#include <iosfwd>
#include <optional>
 
namespace o2::mch::raw
{
class DsElecId
{
 public:
  explicit DsElecId(uint16_t solarId, uint8_t elinkGroupId, uint8_t elinkIndex);
 
  constexpr uint8_t elinkIndexInGroup() const
  {
    return mElinkIndexInGroup;
  }
 
  constexpr uint8_t elinkGroupId() const
  {
    return mElinkGroupId;
  }
 
  constexpr uint8_t elinkId() const
  {
    return mElinkGroupId * 5 + mElinkIndexInGroup;
  }
 
  constexpr uint16_t solarId() const
  {
    return mSolarId;
  }
 
  bool operator<(const DsElecId& rhs) const
  {
    if (mSolarId < rhs.mSolarId) {
      return true;
    } else if (mElinkIndexInGroup < rhs.mElinkIndexInGroup) {
      return true;
    } else if (mElinkGroupId < rhs.mElinkGroupId) {
      return true;
    }
    return false;
  }
 
  bool operator==(const DsElecId& rhs) const
  {
    return mSolarId == rhs.mSolarId &&
           mElinkIndexInGroup == rhs.mElinkIndexInGroup &&
           mElinkGroupId == rhs.mElinkGroupId;
  }
  bool operator!=(const DsElecId& rhs) const
  {
    return !(*this == rhs);
  }
 
 private:
  uint16_t mSolarId;
  uint8_t mElinkGroupId;      // 0..7
  uint8_t mElinkIndexInGroup; // 0..4
};
 
uint32_t encode(const DsElecId& id);
 
std::optional<DsElecId> decodeDsElecId(uint32_t code);
 
std::optional<DsElecId> decodeDsElecId(std::string rep);
 
std::optional<uint8_t> decodeChannelId(std::string rep);
 
std::ostream& operator<<(std::ostream& os, const DsElecId& id);
 
std::string asString(DsElecId dsId);
 
std::optional<uint8_t> groupFromElinkId(uint8_t elinkId);
 
std::optional<uint8_t> indexFromElinkId(uint8_t elinkId);
 
} // namespace o2::mch::raw
 
#endif