RawCalorimeterHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_RawCalorimeterHit_H
#define EICD_RawCalorimeterHit_H
 
#include "eicd/RawCalorimeterHitObj.h"
 
#include <cstdint>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
 
 
namespace eicd {
 
class MutableRawCalorimeterHit;
 
/** @class RawCalorimeterHit
 *  Raw (digitized) calorimeter hit
 *  @author: W. Armstrong, S. Joosten
 */
class RawCalorimeterHit {
 
  friend class MutableRawCalorimeterHit;
  friend class RawCalorimeterHitCollection;
  friend class RawCalorimeterHitCollectionIterator;
 
public:
  /// default constructor
  RawCalorimeterHit();
  RawCalorimeterHit(std::uint64_t cellID, std::uint64_t amplitude, std::uint64_t timeStamp);
 
  /// constructor from existing RawCalorimeterHitObj
  RawCalorimeterHit(RawCalorimeterHitObj* obj);
 
  /// copy constructor
  RawCalorimeterHit(const RawCalorimeterHit& other);
 
  /// copy-assignment operator
  RawCalorimeterHit& operator=(RawCalorimeterHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableRawCalorimeterHit clone() const;
 
  /// destructor
  ~RawCalorimeterHit();
 
 
public:
 
  /// Access the The detector specific (geometrical) cell id.
  const std::uint64_t& getCellID() const;
 
  /// Access the The magnitude of the hit in ADC counts.
  const std::uint64_t& getAmplitude() const;
 
  /// Access the Timing in TDC
  const std::uint64_t& getTimeStamp() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawCalorimeterHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const RawCalorimeterHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableRawCalorimeterHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawCalorimeterHit& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(RawCalorimeterHit& a, RawCalorimeterHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  RawCalorimeterHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const RawCalorimeterHit& value);
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const RawCalorimeterHit& value);
#endif
 
 
} // namespace eicd
 
 
#endif