RawPMTHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_RawPMTHit_H
#define EICD_RawPMTHit_H
 
#include "eicd/RawPMTHitObj.h"
 
#include <cstdint>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
 
 
namespace eicd {
 
class MutableRawPMTHit;
 
/** @class RawPMTHit
 *  EIC Raw PMT hit
 *  @author: S. Joosten, C. Peng
 */
class RawPMTHit {
 
  friend class MutableRawPMTHit;
  friend class RawPMTHitCollection;
  friend class RawPMTHitCollectionIterator;
 
public:
  /// default constructor
  RawPMTHit();
  RawPMTHit(std::uint64_t cellID, std::uint32_t integral, std::uint32_t timeStamp);
 
  /// constructor from existing RawPMTHitObj
  RawPMTHit(RawPMTHitObj* obj);
 
  /// copy constructor
  RawPMTHit(const RawPMTHit& other);
 
  /// copy-assignment operator
  RawPMTHit& operator=(RawPMTHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableRawPMTHit clone() const;
 
  /// destructor
  ~RawPMTHit();
 
 
public:
 
  /// Access the The detector specific (geometrical) cell id.
  const std::uint64_t& getCellID() const;
 
  /// Access the PMT signal integral [ADC]
  const std::uint32_t& getIntegral() const;
 
  /// Access the PMT signal time [TDC]
  const std::uint32_t& getTimeStamp() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawPMTHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const RawPMTHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableRawPMTHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawPMTHit& 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(RawPMTHit& a, RawPMTHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  RawPMTHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const RawPMTHit& value);
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const RawPMTHit& value);
#endif
 
 
} // namespace eicd
 
 
#endif