Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-11-18 10:28:14

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002 
0003 #ifndef EDM4HEP_MutableParticleID_H
0004 #define EDM4HEP_MutableParticleID_H
0005 
0006 #include "edm4hep/ParticleIDObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4hep/ParticleID.h"
0009 
0010 #include "podio/RelationRange.h"
0011 #include <cstdint>
0012 #include <vector>
0013 
0014 #include "podio/utilities/MaybeSharedPtr.h"
0015 
0016 #include <cstdint>
0017 
0018 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0019 #include "nlohmann/json_fwd.hpp"
0020 #endif
0021 
0022 // forward declarations
0023 namespace edm4hep {
0024 class ParticleIDCollection;
0025 class ReconstructedParticle;
0026 class MutableReconstructedParticle;
0027 } // namespace edm4hep
0028 
0029 namespace edm4hep {
0030 
0031 /** @class MutableParticleID
0032  *  ParticleID
0033  *  @author: EDM4hep authors
0034  */
0035 class MutableParticleID {
0036 
0037   friend class ParticleIDCollection;
0038   friend class ParticleIDMutableCollectionIterator;
0039   friend class ParticleID;
0040 
0041 public:
0042   using object_type = ParticleID;
0043   using collection_type = ParticleIDCollection;
0044 
0045   /// default constructor
0046   MutableParticleID() = default;
0047 
0048   /// Constructor initializing all members
0049   MutableParticleID(const std::int32_t type, const std::int32_t PDG, const std::int32_t algorithmType,
0050                     const float likelihood);
0051 
0052   /// copy constructor
0053   MutableParticleID(const MutableParticleID& other) noexcept = default;
0054 
0055   /// move constructor
0056   MutableParticleID(MutableParticleID&& other) noexcept = default;
0057 
0058   /// copy-assignment operator
0059   MutableParticleID& operator=(MutableParticleID other) &; // Rebind this to other's internal object
0060   MutableParticleID&
0061   operator=(MutableParticleID other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0062 
0063   /// create a mutable deep-copy of the object with identical relations
0064   /// if cloneRelations=false, the relations are not cloned and will be empty
0065   MutableParticleID clone(bool cloneRelations = true) const;
0066 
0067   /// destructor
0068   ~MutableParticleID() = default;
0069 
0070 public:
0071   /// Access the userdefined type
0072   std::int32_t getType() const;
0073 
0074   /// Access the PDG code of this id - ( 999999 ) if unknown
0075   std::int32_t getPDG() const;
0076 
0077   /// Access the type of the algorithm/module that created this hypothesis
0078   std::int32_t getAlgorithmType() const;
0079 
0080   /// Access the likelihood of this hypothesis - in a user defined normalization
0081   float getLikelihood() const;
0082 
0083   /// Access the the particle from which this PID has been computed
0084   const edm4hep::ReconstructedParticle getParticle() const;
0085 
0086   /// Set the userdefined type
0087   void setType(const std::int32_t type);
0088   /// Get mutable reference to userdefined type
0089   std::int32_t& getType();
0090 
0091   /// Set the PDG code of this id - ( 999999 ) if unknown
0092   void setPDG(const std::int32_t PDG);
0093   /// Get mutable reference to PDG code of this id - ( 999999 ) if unknown
0094   std::int32_t& getPDG();
0095 
0096   /// Set the type of the algorithm/module that created this hypothesis
0097   void setAlgorithmType(const std::int32_t algorithmType);
0098   /// Get mutable reference to type of the algorithm/module that created this hypothesis
0099   std::int32_t& getAlgorithmType();
0100 
0101   /// Set the likelihood of this hypothesis - in a user defined normalization
0102   void setLikelihood(const float likelihood);
0103   /// Get mutable reference to likelihood of this hypothesis - in a user defined normalization
0104   float& getLikelihood();
0105 
0106   /// Set the the particle from which this PID has been computed
0107   void setParticle(const edm4hep::ReconstructedParticle& value);
0108 
0109   void addToParameters(const float&);
0110   std::size_t parameters_size() const;
0111   float getParameters(std::size_t) const;
0112   std::vector<float>::const_iterator parameters_begin() const;
0113   std::vector<float>::const_iterator parameters_end() const;
0114   podio::RelationRange<float> getParameters() const;
0115 
0116   /// check whether the object is actually available
0117   bool isAvailable() const;
0118   /// disconnect from ParticleIDObj instance
0119   void unlink() { m_obj = podio::utils::MaybeSharedPtr<ParticleIDObj>{nullptr}; }
0120 
0121   constexpr bool operator==(const MutableParticleID& other) const { return m_obj == other.m_obj; }
0122   bool operator==(const ParticleID& other) const;
0123 
0124   constexpr bool operator!=(const MutableParticleID& other) const { return !(*this == other); }
0125   bool operator!=(const ParticleID& other) const { return !(*this == other); }
0126 
0127   // less comparison operator, so that objects can be e.g. stored in sets.
0128   bool operator<(const MutableParticleID& other) const {
0129     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0130   }
0131 
0132   podio::ObjectID id() const { return getObjectID(); }
0133 
0134   const podio::ObjectID getObjectID() const;
0135 
0136   friend std::hash<MutableParticleID>;
0137 
0138   friend void swap(MutableParticleID& a, MutableParticleID& b) {
0139     using std::swap;
0140     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0141   }
0142 
0143 private:
0144   /// constructor from existing ParticleIDObj
0145   explicit MutableParticleID(podio::utils::MaybeSharedPtr<ParticleIDObj> obj);
0146 
0147   podio::utils::MaybeSharedPtr<ParticleIDObj> m_obj{new ParticleIDObj{}, podio::utils::MarkOwned};
0148 };
0149 
0150 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0151 void to_json(nlohmann::json& j, const MutableParticleID& value);
0152 #endif
0153 
0154 } // namespace edm4hep
0155 
0156 template <>
0157 struct std::hash<edm4hep::MutableParticleID> {
0158   std::size_t operator()(const edm4hep::MutableParticleID& obj) const {
0159     return std::hash<edm4hep::ParticleIDObj*>{}(obj.m_obj.get());
0160   }
0161 };
0162 
0163 #endif