include/edm4eic/MutableTrackClusterMatch.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableTrackClusterMatch_H
0004 #define EDM4EIC_MutableTrackClusterMatch_H
0005
0006 #include "edm4eic/TrackClusterMatchObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/TrackClusterMatch.h"
0009
0010
0011 #include "podio/utilities/MaybeSharedPtr.h"
0012
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 TrackClusterMatchCollection;
0022 class Cluster;
0023 class MutableCluster;
0024 class Track;
0025 class MutableTrack;
0026 }
0027
0028
0029 namespace edm4eic {
0030
0031
0032 /** @class MutableTrackClusterMatch
0033  *  Match between a Cluster and a Track
0034  *  @author: D. Anderson, D. Brandenburg, D. Kalinkin, S. Joosten
0035  */
0036 class MutableTrackClusterMatch {
0037
0038   friend class TrackClusterMatchCollection;
0039   friend class TrackClusterMatchMutableCollectionIterator;
0040   friend class TrackClusterMatch;
0041
0042 public:
0043   using object_type = TrackClusterMatch;
0044   using collection_type = TrackClusterMatchCollection;
0045
0046   /// default constructor
0047   MutableTrackClusterMatch();
0048
0049   /// Constructor initializing all members
0050   MutableTrackClusterMatch(const float weight);
0051
0052   /// copy constructor
0053   MutableTrackClusterMatch(const MutableTrackClusterMatch& other) = default;
0054
0055   /// copy-assignment operator
0056   MutableTrackClusterMatch& operator=(MutableTrackClusterMatch other) &; // Rebind this to other's internal object
0057   MutableTrackClusterMatch& operator=(MutableTrackClusterMatch other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0058
0059   /// create a mutable deep-copy of the object with identical relations
0060   /// if cloneRelations=false, the relations are not cloned and will be empty
0061   MutableTrackClusterMatch clone(bool cloneRelations=true) const;
0062
0063   /// destructor
0064   ~MutableTrackClusterMatch() = default;
0065
0066
0067 public:
0068
0069   /// Access the weight of this association
0070   float getWeight() const;
0071
0072
0073   /// Access the reference to the cluster
0074   const edm4eic::Cluster getCluster() const;
0075   /// Access the reference to the track
0076   const edm4eic::Track getTrack() const;
0077
0078   /// Set the weight of this association
0079   void setWeight(const float weight);
0080   /// Get mutable reference to weight of this association
0081   float& getWeight();
0082   /// Get reference to weight of this association
0083   [[deprecated("use getWeight instead")]]
0084   float& weight();
0085
0086
0087   /// Set the reference to the cluster
0088   void setCluster(const edm4eic::Cluster& value);
0089   /// Set the reference to the track
0090   void setTrack(const edm4eic::Track& value);
0091
0092
0093
0094
0095   /// check whether the object is actually available
0096   bool isAvailable() const;
0097   /// disconnect from TrackClusterMatchObj instance
0098   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackClusterMatchObj>{nullptr}; }
0099
0100   bool operator==(const MutableTrackClusterMatch& other) const { return m_obj == other.m_obj; }
0101   bool operator==(const TrackClusterMatch& other) const;
0102
0103   bool operator!=(const MutableTrackClusterMatch& other) const { return !(*this == other); }
0104   bool operator!=(const TrackClusterMatch& other) const { return !(*this == other); }
0105
0106   // less comparison operator, so that objects can be e.g. stored in sets.
0107   bool operator<(const MutableTrackClusterMatch& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0108
0109   podio::ObjectID id() const { return getObjectID(); }
0110
0111   const podio::ObjectID getObjectID() const;
0112
0113   friend std::hash<MutableTrackClusterMatch>;
0114
0115   friend void swap(MutableTrackClusterMatch& a, MutableTrackClusterMatch& b) {
0116     using std::swap;
0117     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0118   }
0119
0120 private:
0121   /// constructor from existing TrackClusterMatchObj
0122   explicit MutableTrackClusterMatch(podio::utils::MaybeSharedPtr<TrackClusterMatchObj> obj);
0123
0124   podio::utils::MaybeSharedPtr<TrackClusterMatchObj> m_obj{nullptr};
0125 };
0126
0127 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0128 void to_json(nlohmann::json& j, const MutableTrackClusterMatch& value);
0129 #endif
0130
0131
0132 } // namespace edm4eic
0133
0134
0135
0136 template<>
0137 struct std::hash<edm4eic::MutableTrackClusterMatch> {
0138   std::size_t operator()(const edm4eic::MutableTrackClusterMatch& obj) const {
0139     return std::hash<edm4eic::TrackClusterMatchObj*>{}(obj.m_obj.get());
0140   }
0141 };
0142
0143
0144 #endif