include/edm4eic/MCRecoTrackerHitAssociation.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MCRecoTrackerHitAssociation_H
0004 #define EDM4EIC_MCRecoTrackerHitAssociation_H
0005
0006 #include "edm4eic/MCRecoTrackerHitAssociationObj.h"
0007
0008
0009 #include "podio/utilities/MaybeSharedPtr.h"
0010 #include "podio/detail/OrderKey.h"
0011
0012 #include <ostream>
0013 #include <cstdint>
0014
0015 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0016 #include "nlohmann/json_fwd.hpp"
0017 #endif
0018
0019 // forward declarations
0020 namespace edm4eic {
0021 class MCRecoTrackerHitAssociationCollection;
0022 class RawTrackerHit;
0023 class MutableRawTrackerHit;
0024 }
0025 namespace edm4hep {
0026 class SimTrackerHit;
0027 class MutableSimTrackerHit;
0028 }
0029
0030
0031 namespace podio::detail {
0032 // Internal function used in less comparison operators of the datatypes and interface types
0033 OrderKey getOrderKey(const edm4eic::MCRecoTrackerHitAssociation& obj);
0034 };
0035
0036 namespace edm4eic {
0037
0038 class MutableMCRecoTrackerHitAssociation;
0039 class MCRecoTrackerHitAssociationCollection;
0040 class MCRecoTrackerHitAssociationCollectionData;
0041
0042 /** @class MCRecoTrackerHitAssociation
0043  *  Association between a RawTrackerHit and a SimTrackerHit
0044  *  @author: C. Dilks, W. Deconinck
0045  */
0046 class MCRecoTrackerHitAssociation {
0047
0048   friend class MutableMCRecoTrackerHitAssociation;
0049   friend class MCRecoTrackerHitAssociationCollection;
0050   friend class edm4eic::MCRecoTrackerHitAssociationCollectionData;
0051   friend class MCRecoTrackerHitAssociationCollectionIterator;
0052   friend podio::detail::OrderKey podio::detail::getOrderKey(const MCRecoTrackerHitAssociation & obj);
0053
0054 public:
0055   using mutable_type = MutableMCRecoTrackerHitAssociation;
0056   using collection_type = MCRecoTrackerHitAssociationCollection;
0057
0058   /// default constructor
0059   MCRecoTrackerHitAssociation();
0060
0061   /// Constructor initializing all members
0062   MCRecoTrackerHitAssociation(const float weight);
0063
0064   /// copy constructor
0065   MCRecoTrackerHitAssociation(const MCRecoTrackerHitAssociation& other) = default;
0066
0067   /// copy-assignment operator
0068   MCRecoTrackerHitAssociation& operator=(MCRecoTrackerHitAssociation other) &; // Rebind this to other's internal object
0069   MCRecoTrackerHitAssociation& operator=(MCRecoTrackerHitAssociation other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0070
0071   /// create a mutable deep-copy of the object with identical relations
0072   /// if cloneRelations=false, the relations are not cloned and will be empty
0073   MutableMCRecoTrackerHitAssociation clone(bool cloneRelations=true) const;
0074
0075   /// destructor
0076   ~MCRecoTrackerHitAssociation() = default;
0077
0078   /// converting constructor from mutable object
0079   MCRecoTrackerHitAssociation(const MutableMCRecoTrackerHitAssociation& other);
0080
0081   static MCRecoTrackerHitAssociation makeEmpty();
0082
0083 public:
0084
0085   static constexpr std::string_view typeName = "edm4eic::MCRecoTrackerHitAssociation";
0086
0087   /// Access the weight of this association
0088   float getWeight() const;
0089
0090
0091   /// Access the reference to the digitized hit
0092   const edm4eic::RawTrackerHit getRawHit() const;
0093   /// Access the reference to the simulated hit
0094   const edm4hep::SimTrackerHit getSimHit() const;
0095
0096
0097
0098   /// check whether the object is actually available
0099   bool isAvailable() const;
0100   /// disconnect from MCRecoTrackerHitAssociationObj instance
0101   void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj>{nullptr}; }
0102
0103   bool operator==(const MCRecoTrackerHitAssociation& other) const { return m_obj == other.m_obj; }
0104   bool operator==(const MutableMCRecoTrackerHitAssociation& other) const;
0105
0106   bool operator!=(const MCRecoTrackerHitAssociation& other) const { return !(*this == other); }
0107   bool operator!=(const MutableMCRecoTrackerHitAssociation& other) const { return !(*this == other); }
0108
0109   // less comparison operator, so that objects can be e.g. stored in sets.
0110   bool operator<(const MCRecoTrackerHitAssociation& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0111
0112   podio::ObjectID id() const { return getObjectID(); }
0113
0114   const podio::ObjectID getObjectID() const;
0115
0116   friend std::hash<MCRecoTrackerHitAssociation>;
0117
0118   friend void swap(MCRecoTrackerHitAssociation& a, MCRecoTrackerHitAssociation& b) {
0119     using std::swap;
0120     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0121   }
0122
0123 private:
0124   /// constructor from existing MCRecoTrackerHitAssociationObj
0125   explicit MCRecoTrackerHitAssociation(podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj> obj);
0126   MCRecoTrackerHitAssociation(MCRecoTrackerHitAssociationObj* obj);
0127
0128   podio::utils::MaybeSharedPtr<MCRecoTrackerHitAssociationObj> m_obj{nullptr};
0129 };
0130
0131 std::ostream& operator<<(std::ostream& o, const MCRecoTrackerHitAssociation& value);
0132
0133 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0134 void to_json(nlohmann::json& j, const MCRecoTrackerHitAssociation& value);
0135 #endif
0136
0137
0138 } // namespace edm4eic
0139
0140
0141
0142 template<>
0143 struct std::hash<edm4eic::MCRecoTrackerHitAssociation> {
0144   std::size_t operator()(const edm4eic::MCRecoTrackerHitAssociation& obj) const {
0145     return std::hash<edm4eic::MCRecoTrackerHitAssociationObj*>{}(obj.m_obj.get());
0146   }
0147 };
0148
0149
0150 // This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
0151 // until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
0152 // and https://github.com/AIDASoft/podio/issues/770
0153 #if defined(__clang__)
0154 #pragma clang diagnostic push
0155 #pragma clang diagnostic ignored "-Wunknown-warning-option"
0156 #pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
0157 #pragma clang diagnostic ignored "-Wdeprecated"
0158 constexpr std::string_view edm4eic::MCRecoTrackerHitAssociation::typeName;
0159 #pragma clang diagnostic pop
0160 #elif defined(__GNUC__)
0161 #pragma GCC diagnostic push
0162 #pragma GCC diagnostic ignored "-Wdeprecated"
0163 constexpr std::string_view edm4eic::MCRecoTrackerHitAssociation::typeName;
0164 #pragma GCC diagnostic pop
0165 #endif
0166
0167 #endif