RawTrackerHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_RawTrackerHit_H
#define EDM4EIC_RawTrackerHit_H
 
#include "edm4eic/RawTrackerHitObj.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 RawTrackerHitCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::RawTrackerHit& obj);
};
 
namespace edm4eic {
 
class MutableRawTrackerHit;
class RawTrackerHitCollection;
class RawTrackerHitCollectionData;
 
/** @class RawTrackerHit
 *  Raw (digitized) tracker hit
 *  @author: W. Armstrong, S. Joosten
 */
class RawTrackerHit {
 
  friend class MutableRawTrackerHit;
  friend class RawTrackerHitCollection;
  friend class edm4eic::RawTrackerHitCollectionData;
  friend class RawTrackerHitCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const RawTrackerHit & obj);
 
public:
  using mutable_type = MutableRawTrackerHit;
  using collection_type = RawTrackerHitCollection;
 
  /// default constructor
  RawTrackerHit();
 
  /// Constructor initializing all members
  RawTrackerHit(std::uint64_t cellID, std::int32_t charge, std::int32_t timeStamp);
 
  /// copy constructor
  RawTrackerHit(const RawTrackerHit& other) = default;
 
  /// copy-assignment operator
  RawTrackerHit& operator=(RawTrackerHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableRawTrackerHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~RawTrackerHit() = default;
 
  /// converting constructor from mutable object
  RawTrackerHit(const MutableRawTrackerHit& other);
 
  static RawTrackerHit makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::RawTrackerHit";
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the ADC value
  std::int32_t getCharge() const;
 
  /// Access the TDC value.
  std::int32_t getTimeStamp() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawTrackerHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr}; }
 
  bool operator==(const RawTrackerHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableRawTrackerHit& other) const;
 
  bool operator!=(const RawTrackerHit& other) const { return !(*this == other); }
  bool operator!=(const MutableRawTrackerHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawTrackerHit& 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(RawTrackerHit& a, RawTrackerHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RawTrackerHitObj
  explicit RawTrackerHit(podio::utils::MaybeSharedPtr<RawTrackerHitObj> obj);
  RawTrackerHit(RawTrackerHitObj* obj);
 
  podio::utils::MaybeSharedPtr<RawTrackerHitObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const RawTrackerHit& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const RawTrackerHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif