L1GctInternEtSum.h

Go to the documentation of this file.

#ifndef L1GCTINTERNETSUM_H
#define L1GCTINTERNETSUM_H

#include <ostream>
#include <string>
#include <cstdint>



class L1GctInternEtSum {

 public:

  enum L1GctInternEtSumType { null,
                  jet_tot_et,      // from jet_tot_et_and_ht in leaf output
                  jet_tot_ht,      // from jet_tot_et_and_ht in leaf output
                  jet_miss_et,     // leaf output
                  total_et_or_ht,  // conc input, wheel input and output
                              miss_etx_or_ety  // conc input, wheel input and output
  };

  enum numberOfBits {
    kTotEtOrHtNBits   = 12,
    kJetMissEtNBits   = 17,
    kMissExOrEyNBits  = 20,
    kTotEtOrHtOFlowBit  = 1 << kTotEtOrHtNBits,
    kJetMissEtOFlowBit  = 1 << kJetMissEtNBits,
    kMissExOrEyOFlowBit = 1 << kMissExOrEyNBits,
    kTotEtOrHtMaxValue  = kTotEtOrHtOFlowBit  - 1,
    kJetMissEtMaxValue  = kJetMissEtOFlowBit  - 1,
    kMissExOrEyMaxValue = kMissExOrEyOFlowBit - 1,
    kTotEtOrHtRawCtorMask  = kTotEtOrHtOFlowBit  | kTotEtOrHtMaxValue,
    kJetMissEtRawCtorMask  = kJetMissEtOFlowBit  | kJetMissEtMaxValue,
    kMissExOrEyRawCtorMask = kMissExOrEyOFlowBit | kMissExOrEyMaxValue
  };

  L1GctInternEtSum();

  L1GctInternEtSum(uint16_t capBlock,
           uint16_t capIndex,
           int16_t bx,
           uint32_t et,
           uint8_t oflow);

  ~L1GctInternEtSum();

  // named ctors
  static L1GctInternEtSum fromJetTotEt(uint16_t capBlock,
                       uint16_t capIndex,
                       int16_t bx,
                       uint32_t data);

  static L1GctInternEtSum fromJetTotHt(uint16_t capBlock,
                       uint16_t capIndex,
                       int16_t bx,
                       uint32_t data);
  
  static L1GctInternEtSum fromJetMissEt(uint16_t capBlock,
                    uint16_t capIndex,
                    int16_t bx,
                    uint32_t data);
  

  static L1GctInternEtSum fromTotalEtOrHt(uint16_t capBlock,
                                          uint16_t capIndex,
                                          int16_t bx,
                                          uint32_t data);

  static L1GctInternEtSum fromMissEtxOrEty(uint16_t capBlock,
                                          uint16_t capIndex,
                                          int16_t bx,
                                          uint32_t data);

  static L1GctInternEtSum fromEmulatorJetTotEt(unsigned totEt, bool overFlow, int16_t bx);

  static L1GctInternEtSum fromEmulatorJetTotHt(unsigned totHt, bool overFlow, int16_t bx);
  
  static L1GctInternEtSum fromEmulatorJetMissEt(int missEtxOrEty, bool overFlow, int16_t bx);
  
  static L1GctInternEtSum fromEmulatorTotalEtOrHt(unsigned totEtOrHt, bool overFlow, int16_t bx);

  static L1GctInternEtSum fromEmulatorMissEtxOrEty(int missEtxOrEty, bool overFlow, int16_t bx);


  L1GctInternEtSum::L1GctInternEtSumType type() const { return type_; }

  uint16_t capBlock() const { return capBlock_; }

  uint16_t capIndex() const { return capIndex_; }

  int16_t bx() const { return bx_; }

  bool empty() const { return (data_ == 0); }



  uint32_t raw() const { return data_; }
  
  uint32_t value() const { return data_ & 0x7fffffff; }

  uint32_t et() const { return value(); }

  uint32_t count() const { return value(); }

  uint8_t oflow() const { return (data_>>31) & 0x1; }


  // setters

  void setCapBlock(uint16_t capBlock) { capBlock_ = capBlock; }

  void setCapIndex(uint16_t capIndex) { capIndex_ = capIndex; }

  void setBx(uint16_t bx) { bx_ = bx; }

  void setType(L1GctInternEtSumType type) { type_ = type; }

  void setValue(uint32_t val);

  void setEt(uint32_t et);

  void setCount(uint32_t count);

  void setOflow(uint8_t oflow);



  bool operator==(const L1GctInternEtSum& c) const;
  
  bool operator!=(const L1GctInternEtSum& c) const { return !(*this == c); }
  

 private:

  // type of data
  L1GctInternEtSumType type_;

  // source of the data
  uint16_t capBlock_;
  uint16_t capIndex_;
  int16_t bx_;

  // the captured data
  uint32_t data_;

 };

std::ostream& operator<<(std::ostream& s, const L1GctInternEtSum& c);

#endif