Channel.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 ALICEO2_EMCAL_CHANNEL_H
#define ALICEO2_EMCAL_CHANNEL_H
 
#include <cstdint>
#include <exception>
#include <vector>
#include "Rtypes.h"
#include "EMCALReconstruction/Bunch.h"
 
namespace o2
{
 
namespace emcal
{
 
class Channel
{
 public:
  class HardwareAddressError : public std::exception
  {
   public:
    HardwareAddressError() = default;
 
    ~HardwareAddressError() noexcept override = default;
 
    const char* what() const noexcept override
    {
      return "Hardware address not initialized";
    }
  };
 
  Channel() = default;
 
  Channel(int32_t hardwareAddress, uint8_t payloadSize) : mHardwareAddress(hardwareAddress),
                                                          mPayloadSize(payloadSize),
                                                          mBunches()
  {
  }
 
  ~Channel() = default;
 
  bool isBadChannel() const { return mBadChannel; }
 
  uint16_t getHardwareAddress() const { return mHardwareAddress; }
 
  uint16_t getPayloadSize() const { return mPayloadSize; }
 
  const std::vector<Bunch>& getBunches() const { return mBunches; }
 
  int getBranchIndex() const;
 
  int getFECIndex() const;
 
  int getAltroIndex() const;
 
  int getChannelIndex() const;
 
  void addBunch(const Bunch& bunch) { mBunches.emplace_back(bunch); }
 
  void setHardwareAddress(uint16_t hardwareAddress) { mHardwareAddress = hardwareAddress; }
 
  void setPayloadSize(uint8_t payloadSize) { mPayloadSize = payloadSize; }
 
  void setBadChannel(bool badchannel) { mBadChannel = badchannel; }
 
  Bunch& createBunch(uint8_t bunchlength, uint8_t starttime);
 
  static int getHardwareAddressFromChannelHeader(int channelheader) { return channelheader & 0xFFF; };
 
  static int getPayloadSizeFromChannelHeader(int channelheader) { return (channelheader >> 16) & 0x3FF; }
 
  static int getBranchIndexFromHwAddress(int hwaddress) { return ((hwaddress >> 11) & 0x1); }
 
  static int getFecIndexFromHwAddress(int hwaddress) { return ((hwaddress >> 7) & 0xF); }
 
  static int getAltroIndexFromHwAddress(int hwaddress) { return ((hwaddress >> 4) & 0x7); }
 
  static int getChannelIndexFromHwAddress(int hwaddress) { return (hwaddress & 0xF); }
 
 private:
  int32_t mHardwareAddress = -1; 
  uint16_t mPayloadSize = 0;     
  bool mBadChannel;              
  std::vector<Bunch> mBunches;   
 
  ClassDefNV(Channel, 1);
};
 
} // namespace emcal
} // namespace o2
 
#endif