PMTHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_PMTHit_H
#define EDM4EIC_PMTHit_H
 
#include "edm4eic/PMTHitObj.h"
 
#include "edm4hep/Vector3f.h"
#include <cstdint>
 
#include "podio/utilities/MaybeSharedPtr.h"
#include "podio/detail/OrderKey.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class PMTHitCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::PMTHit& obj);
};
 
namespace edm4eic {
 
class MutablePMTHit;
class PMTHitCollection;
class PMTHitCollectionData;
 
/** @class PMTHit
 *  EIC PMT hit
 *  @author: S. Joosten, C. Peng
 */
class PMTHit {
 
  friend class MutablePMTHit;
  friend class PMTHitCollection;
  friend class edm4eic::PMTHitCollectionData;
  friend class PMTHitCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const PMTHit & obj);
 
public:
  using mutable_type = MutablePMTHit;
  using collection_type = PMTHitCollection;
 
  /// default constructor
  PMTHit();
 
  /// Constructor initializing all members
  PMTHit(std::uint64_t cellID, float npe, float time, float timeError, edm4hep::Vector3f position, edm4hep::Vector3f dimension, std::int32_t sector, edm4hep::Vector3f local);
 
  /// copy constructor
  PMTHit(const PMTHit& other) = default;
 
  /// copy-assignment operator
  PMTHit& operator=(PMTHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutablePMTHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~PMTHit() = default;
 
  /// converting constructor from mutable object
  PMTHit(const MutablePMTHit& other);
 
  static PMTHit makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::PMTHit";
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the Estimated number of photo-electrons [#]
  float getNpe() const;
 
  /// Access the Time [ns]
  float getTime() const;
 
  /// Access the Error on the time [ns]
  float getTimeError() const;
 
  /// Access the PMT hit position [mm]
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the The dimension information of the pixel [mm].
  const edm4hep::Vector3f& getDimension() const;
 
  /// Access the The sector this hit occurred in
  std::int32_t getSector() const;
 
  /// Access the The local position of the hit in detector coordinates (relative to the sector) [mm]
  const edm4hep::Vector3f& getLocal() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from PMTHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<PMTHitObj>{nullptr}; }
 
  bool operator==(const PMTHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutablePMTHit& other) const;
 
  bool operator!=(const PMTHit& other) const { return !(*this == other); }
  bool operator!=(const MutablePMTHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const PMTHit& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(PMTHit& a, PMTHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing PMTHitObj
  explicit PMTHit(podio::utils::MaybeSharedPtr<PMTHitObj> obj);
  PMTHit(PMTHitObj* obj);
 
  podio::utils::MaybeSharedPtr<PMTHitObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const PMTHit& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const PMTHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif