EDM4eic
EIC data model
Loading...
Searching...
No Matches
RawTrackerHit.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_RawTrackerHit_H
4#define EDM4EIC_RawTrackerHit_H
5
7
8#include <cstdint>
9
10#include "podio/utilities/MaybeSharedPtr.h"
11#include "podio/detail/OrderKey.h"
12
13#include <ostream>
14#include <cstdint>
15
16#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
17#include "nlohmann/json_fwd.hpp"
18#endif
19
20// forward declarations
21namespace edm4eic {
23}
24
25
26namespace podio::detail {
27// Internal function used in less comparison operators of the datatypes and interface types
28OrderKey getOrderKey(const edm4eic::RawTrackerHit& obj);
29};
30
31namespace edm4eic {
32
36
37/** @class RawTrackerHit
38 * Raw (digitized) tracker hit
39 * @author: W. Armstrong, S. Joosten
40 */
42
47 friend podio::detail::OrderKey podio::detail::getOrderKey(const RawTrackerHit & obj);
48
49public:
52
53 /// default constructor
55
56 /// Constructor initializing all members
57 RawTrackerHit(const std::uint64_t cellID, const std::int32_t charge, const std::int32_t timeStamp);
58
59 /// copy constructor
60 RawTrackerHit(const RawTrackerHit& other) = default;
61
62 /// copy-assignment operator
63 RawTrackerHit& operator=(RawTrackerHit other) &; // Rebind this to other's internal object
64 RawTrackerHit& operator=(RawTrackerHit other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
65
66 /// create a mutable deep-copy of the object with identical relations
67 /// if cloneRelations=false, the relations are not cloned and will be empty
68 MutableRawTrackerHit clone(bool cloneRelations=true) const;
69
70 /// destructor
71 ~RawTrackerHit() = default;
72
73 /// converting constructor from mutable object
75
76 static RawTrackerHit makeEmpty();
77
78public:
79
80 static constexpr std::string_view typeName = "edm4eic::RawTrackerHit";
81
82 /// Access the The detector specific (geometrical) cell id.
83 std::uint64_t getCellID() const;
84
85 /// Access the ADC value
86 std::int32_t getCharge() const;
87
88 /// Access the TDC value.
89 std::int32_t getTimeStamp() const;
90
91
92
93
94
95 /// check whether the object is actually available
96 bool isAvailable() const;
97 /// disconnect from RawTrackerHitObj instance
98 void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr}; }
99
100 bool operator==(const RawTrackerHit& other) const { return m_obj == other.m_obj; }
101 bool operator==(const MutableRawTrackerHit& other) const;
102
103 bool operator!=(const RawTrackerHit& other) const { return !(*this == other); }
104 bool operator!=(const MutableRawTrackerHit& other) const { return !(*this == other); }
105
106 // less comparison operator, so that objects can be e.g. stored in sets.
107 bool operator<(const RawTrackerHit& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
108
109 podio::ObjectID id() const { return getObjectID(); }
110
111 const podio::ObjectID getObjectID() const;
112
113 friend std::hash<RawTrackerHit>;
114
115 friend void swap(RawTrackerHit& a, RawTrackerHit& b) {
116 using std::swap;
117 swap(a.m_obj, b.m_obj); // swap out the internal pointers
118 }
119
120private:
121 /// constructor from existing RawTrackerHitObj
122 explicit RawTrackerHit(podio::utils::MaybeSharedPtr<RawTrackerHitObj> obj);
124
125 podio::utils::MaybeSharedPtr<RawTrackerHitObj> m_obj{nullptr};
126};
127
128std::ostream& operator<<(std::ostream& o, const RawTrackerHit& value);
129
130#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
131void to_json(nlohmann::json& j, const RawTrackerHit& value);
132#endif
133
134
135} // namespace edm4eic
136
137
138
139template<>
140struct std::hash<edm4eic::RawTrackerHit> {
141 std::size_t operator()(const edm4eic::RawTrackerHit& obj) const {
142 return std::hash<edm4eic::RawTrackerHitObj*>{}(obj.m_obj.get());
143 }
144};
145
146
147// This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
148// until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
149// and https://github.com/AIDASoft/podio/issues/770
150#if defined(__clang__)
151#pragma clang diagnostic push
152#pragma clang diagnostic ignored "-Wunknown-warning-option"
153#pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
154#pragma clang diagnostic ignored "-Wdeprecated"
155constexpr std::string_view edm4eic::RawTrackerHit::typeName;
156#pragma clang diagnostic pop
157#elif defined(__GNUC__)
158#pragma GCC diagnostic push
159#pragma GCC diagnostic ignored "-Wdeprecated"
160constexpr std::string_view edm4eic::RawTrackerHit::typeName;
161#pragma GCC diagnostic pop
162#endif
163
164#endif
Definition MutableRawTrackerHit.h:33
Definition RawTrackerHitCollectionData.h:30
Definition RawTrackerHitCollection.h:137
Definition RawTrackerHit.h:41
const podio::ObjectID getObjectID() const
Definition RawTrackerHit.cc:67
std::uint64_t getCellID() const
Access the The detector specific (geometrical) cell id.
Definition RawTrackerHit.cc:54
MutableRawTrackerHit mutable_type
Definition RawTrackerHit.h:50
~RawTrackerHit()=default
destructor
static constexpr std::string_view typeName
Definition RawTrackerHit.h:80
friend class RawTrackerHitCollectionIterator
Definition RawTrackerHit.h:46
void unlink()
disconnect from RawTrackerHitObj instance
Definition RawTrackerHit.h:98
std::int32_t getTimeStamp() const
Access the TDC value.
Definition RawTrackerHit.cc:56
RawTrackerHit()
default constructor
Definition RawTrackerHit.cc:20
bool operator==(const RawTrackerHit &other) const
Definition RawTrackerHit.h:100
RawTrackerHit & operator=(RawTrackerHit other) &&=delete
bool operator!=(const RawTrackerHit &other) const
Definition RawTrackerHit.h:103
RawTrackerHitCollection collection_type
Definition RawTrackerHit.h:51
friend class MutableRawTrackerHit
Definition RawTrackerHit.h:43
bool isAvailable() const
check whether the object is actually available
Definition RawTrackerHit.cc:63
MutableRawTrackerHit clone(bool cloneRelations=true) const
Definition RawTrackerHit.cc:35
bool operator!=(const MutableRawTrackerHit &other) const
Definition RawTrackerHit.h:104
std::int32_t getCharge() const
Access the ADC value.
Definition RawTrackerHit.cc:55
friend class RawTrackerHitCollection
Definition RawTrackerHit.h:44
bool operator<(const RawTrackerHit &other) const
Definition RawTrackerHit.h:107
RawTrackerHit & operator=(RawTrackerHit other) &
copy-assignment operator
Definition RawTrackerHit.cc:30
podio::ObjectID id() const
Definition RawTrackerHit.h:109
static RawTrackerHit makeEmpty()
Definition RawTrackerHit.cc:50
RawTrackerHit(const RawTrackerHit &other)=default
copy constructor
friend void swap(RawTrackerHit &a, RawTrackerHit &b)
Definition RawTrackerHit.h:115
Definition RawTrackerHitObj.h:17
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:31
OrderKey getOrderKey(const edm4eic::CalorimeterHit &obj)
Definition CalorimeterHit.cc:150
std::size_t operator()(const edm4eic::RawTrackerHit &obj) const
Definition RawTrackerHit.h:141