ChannelCode.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_DATAFORMATS_MCH_CHANNEL_CODE_H_
#define O2_DATAFORMATS_MCH_CHANNEL_CODE_H_
 
#include <RtypesCore.h>
#include <cstdint>
#include <string>
#include "Rtypes.h"
 
namespace o2::mch
{
class ChannelCode
{
 public:
  ChannelCode() = default;
  ChannelCode(uint16_t deId, uint16_t dePadIndex);
  ChannelCode(uint16_t solarId, uint8_t elinkIndex, uint8_t channel);
 
  uint16_t getDeId() const;
  uint16_t getDePadIndex() const;
  uint16_t getDsId() const;
  uint16_t getDsIndex() const;
  uint16_t getSolarId() const;
  uint16_t getSolarIndex() const;
  uint8_t getChannel() const;
  uint8_t getDeIndex() const;
  uint8_t getElinkId() const;
  uint8_t getElinkIndex() const { return getElinkId(); }
 
  /* whether the code is valid.
   *
   * Note that the only way to build an invalid ChannelCode is by using
   * the default constructor, that we cannot suppress
   * (needed e.g. by Root or by some vector functions)
   */
  bool isValid() const { return mValue != sInvalidValue; }
 
  /* get the actual code */
  uint64_t value() const { return mValue; }
 
 private:
  void set(uint8_t deIndex,
           uint16_t dePadIndex,
           uint16_t dsIndex,
           uint16_t solarIndex,
           uint8_t elinkIndex,
           uint8_t channel);
 
 private:
  /* marker for an invalid value. */
  static const uint64_t sInvalidValue{0xFFFFFFFF};
 
  uint64_t mValue{sInvalidValue};
 
  ClassDefNV(ChannelCode, 1); // An identifier for a MCH channel
};
 
std::string asString(const ChannelCode& cc);
 
inline bool operator==(const ChannelCode& a, const ChannelCode& b) { return a.value() == b.value(); }
inline bool operator!=(const ChannelCode& a, const ChannelCode& b) { return a.value() != b.value(); }
inline bool operator<(const ChannelCode& a, const ChannelCode& b) { return a.value() < b.value(); }
inline bool operator>(const ChannelCode& a, const ChannelCode& b) { return a.value() > b.value(); }
inline bool operator<=(const ChannelCode& a, const ChannelCode& b) { return a.value() <= b.value(); }
inline bool operator>=(const ChannelCode& a, const ChannelCode& b) { return a.value() >= b.value(); }
 
} // namespace o2::mch
#endif