EDM4eic
EIC data model
Loading...
Searching...
No Matches
MCRecoParticleAssociation.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_MCRecoParticleAssociation_H
4#define EDM4EIC_MCRecoParticleAssociation_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 {
22class MCRecoParticleAssociationCollection;
23class ReconstructedParticle;
24class MutableReconstructedParticle;
25}
26namespace edm4hep {
27class MCParticle;
28class MutableMCParticle;
29}
30
31
32namespace podio::detail {
33// Internal function used in less comparison operators of the datatypes and interface types
35};
36
37namespace edm4eic {
38
39class MutableMCRecoParticleAssociation;
40class MCRecoParticleAssociationCollection;
41class MCRecoParticleAssociationCollectionData;
42
43/** @class MCRecoParticleAssociation
44 * Used to keep track of the correspondence between MC and reconstructed particles
45 * @author: S. Joosten
46 */
48
53 friend podio::detail::OrderKey podio::detail::getOrderKey(const MCRecoParticleAssociation & obj);
54
55public:
58
59 /// default constructor
61
62 /// Constructor initializing all members
63 MCRecoParticleAssociation(std::uint32_t simID, std::uint32_t recID, float weight);
64
65 /// copy constructor
67
68 /// copy-assignment operator
70
71 /// create a mutable deep-copy of the object with identical relations
72 /// if cloneRelations=false, the relations are not cloned and will be empty
73 MutableMCRecoParticleAssociation clone(bool cloneRelations=true) const;
74
75 /// destructor
77
78 /// converting constructor from mutable object
80
82
83public:
84
85 static constexpr auto typeName = "edm4eic::MCRecoParticleAssociation";
86
87 /// Access the Index of corresponding MCParticle (position in MCParticles array)
88 std::uint32_t getSimID() const;
89
90 /// Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
91 std::uint32_t getRecID() const;
92
93 /// Access the weight of this association
94 float getWeight() const;
95
96
97 /// Access the reference to the reconstructed particle
99 /// Access the reference to the Monte-Carlo particle
100 const edm4hep::MCParticle getSim() const;
101
102
103
104 /// check whether the object is actually available
105 bool isAvailable() const;
106 /// disconnect from MCRecoParticleAssociationObj instance
107 void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj>{nullptr}; }
108
109 bool operator==(const MCRecoParticleAssociation& other) const { return m_obj == other.m_obj; }
110 bool operator==(const MutableMCRecoParticleAssociation& other) const;
111
112 bool operator!=(const MCRecoParticleAssociation& other) const { return !(*this == other); }
113 bool operator!=(const MutableMCRecoParticleAssociation& other) const { return !(*this == other); }
114
115 // less comparison operator, so that objects can be e.g. stored in sets.
117
118 podio::ObjectID id() const { return getObjectID(); }
119
120 const podio::ObjectID getObjectID() const;
121
123 using std::swap;
124 swap(a.m_obj, b.m_obj); // swap out the internal pointers
125 }
126
127private:
128 /// constructor from existing MCRecoParticleAssociationObj
129 explicit MCRecoParticleAssociation(podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> obj);
131
132 podio::utils::MaybeSharedPtr<MCRecoParticleAssociationObj> m_obj{nullptr};
133};
134
135std::ostream& operator<<(std::ostream& o, const MCRecoParticleAssociation& value);
136
137#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
138void to_json(nlohmann::json& j, const MCRecoParticleAssociation& value);
139#endif
140
141
142} // namespace edm4eic
143
144
145#endif
Definition MCRecoParticleAssociationCollectionData.h:32
Definition MCRecoParticleAssociationCollection.h:91
Definition MCRecoParticleAssociationCollection.h:36
Definition MCRecoParticleAssociation.h:47
friend class MutableMCRecoParticleAssociation
Definition MCRecoParticleAssociation.h:49
friend void swap(MCRecoParticleAssociation &a, MCRecoParticleAssociation &b)
Definition MCRecoParticleAssociation.h:122
bool operator<(const MCRecoParticleAssociation &other) const
Definition MCRecoParticleAssociation.h:116
const podio::ObjectID getObjectID() const
Definition MCRecoParticleAssociation.cc:89
const edm4eic::ReconstructedParticle getRec() const
Access the reference to the reconstructed particle.
Definition MCRecoParticleAssociation.cc:66
bool operator!=(const MutableMCRecoParticleAssociation &other) const
Definition MCRecoParticleAssociation.h:113
const edm4hep::MCParticle getSim() const
Access the reference to the Monte-Carlo particle.
Definition MCRecoParticleAssociation.cc:73
bool operator==(const MCRecoParticleAssociation &other) const
Definition MCRecoParticleAssociation.h:109
MutableMCRecoParticleAssociation clone(bool cloneRelations=true) const
Definition MCRecoParticleAssociation.cc:37
std::uint32_t getSimID() const
Access the Index of corresponding MCParticle (position in MCParticles array)
Definition MCRecoParticleAssociation.cc:62
void unlink()
disconnect from MCRecoParticleAssociationObj instance
Definition MCRecoParticleAssociation.h:107
~MCRecoParticleAssociation()=default
destructor
bool isAvailable() const
check whether the object is actually available
Definition MCRecoParticleAssociation.cc:85
MCRecoParticleAssociation(const MCRecoParticleAssociation &other)=default
copy constructor
float getWeight() const
Access the weight of this association.
Definition MCRecoParticleAssociation.cc:64
std::uint32_t getRecID() const
Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
Definition MCRecoParticleAssociation.cc:63
static constexpr auto typeName
Definition MCRecoParticleAssociation.h:85
static MCRecoParticleAssociation makeEmpty()
Definition MCRecoParticleAssociation.cc:58
MCRecoParticleAssociation()
default constructor
Definition MCRecoParticleAssociation.cc:22
MCRecoParticleAssociation & operator=(MCRecoParticleAssociation other)
copy-assignment operator
Definition MCRecoParticleAssociation.cc:32
friend class MCRecoParticleAssociationCollection
Definition MCRecoParticleAssociation.h:50
bool operator!=(const MCRecoParticleAssociation &other) const
Definition MCRecoParticleAssociation.h:112
podio::ObjectID id() const
Definition MCRecoParticleAssociation.h:118
Definition MCRecoParticleAssociationObj.h:24
Definition MutableMCRecoParticleAssociation.h:39
Definition ReconstructedParticle.h:54
Definition CalorimeterHit.cc:17
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:103
Definition CalorimeterHit.h:25
Definition CalorimeterHit.h:31
OrderKey getOrderKey(const edm4eic::CalorimeterHit &obj)
Definition CalorimeterHit.cc:150