TrackerHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_TrackerHit_H
#define EDM4EIC_TrackerHit_H
 
#include "edm4eic/TrackerHitObj.h"
 
#include "edm4eic/CovDiag3f.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 TrackerHitCollection;
class RawTrackerHit;
class MutableRawTrackerHit;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::TrackerHit& obj);
};
 
namespace edm4eic {
 
class MutableTrackerHit;
class TrackerHitCollection;
class TrackerHitCollectionData;
 
/** @class TrackerHit
 *  Tracker hit (reconstructed from Raw)
 *  @author: W. Armstrong, S. Joosten
 */
class TrackerHit {
 
  friend class MutableTrackerHit;
  friend class TrackerHitCollection;
  friend class edm4eic::TrackerHitCollectionData;
  friend class TrackerHitCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const TrackerHit & obj);
 
public:
  using mutable_type = MutableTrackerHit;
  using collection_type = TrackerHitCollection;
 
  /// default constructor
  TrackerHit();
 
  /// Constructor initializing all members
  TrackerHit(std::uint64_t cellID, edm4hep::Vector3f position, edm4eic::CovDiag3f positionError, float time, float timeError, float edep, float edepError);
 
  /// copy constructor
  TrackerHit(const TrackerHit& other) = default;
 
  /// copy-assignment operator
  TrackerHit& operator=(TrackerHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackerHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~TrackerHit() = default;
 
  /// converting constructor from mutable object
  TrackerHit(const MutableTrackerHit& other);
 
  static TrackerHit makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::TrackerHit";
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the Hit (cell) position [mm]
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Covariance Matrix
  const edm4eic::CovDiag3f& getPositionError() const;
 
  /// Access the Hit time [ns]
  float getTime() const;
 
  /// Access the Error on the time
  float getTimeError() const;
 
  /// Access the Energy deposit in this hit [GeV]
  float getEdep() const;
 
  /// Access the Error on the energy deposit [GeV]
  float getEdepError() const;
 
 
  /// Access the Related raw tracker hit
  const edm4eic::RawTrackerHit getRawHit() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackerHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr}; }
 
  bool operator==(const TrackerHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTrackerHit& other) const;
 
  bool operator!=(const TrackerHit& other) const { return !(*this == other); }
  bool operator!=(const MutableTrackerHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const TrackerHit& 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(TrackerHit& a, TrackerHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackerHitObj
  explicit TrackerHit(podio::utils::MaybeSharedPtr<TrackerHitObj> obj);
  TrackerHit(TrackerHitObj* obj);
 
  podio::utils::MaybeSharedPtr<TrackerHitObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const TrackerHit& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const TrackerHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif