include/edm4hep/MutableParticleID.h

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();
0047
0048   /// Constructor initializing all members
0049   MutableParticleID(std::int32_t type, std::int32_t PDG, std::int32_t algorithmType, float likelihood);
0050
0051   /// copy constructor
0052   MutableParticleID(const MutableParticleID& other) = default;
0053
0054   /// copy-assignment operator
0055   MutableParticleID& operator=(MutableParticleID other);
0056
0057   /// create a mutable deep-copy of the object with identical relations
0058   /// if cloneRelations=false, the relations are not cloned and will be empty
0059   MutableParticleID clone(bool cloneRelations = true) const;
0060
0061   /// destructor
0062   ~MutableParticleID() = default;
0063
0064 public:
0065   /// Access the userdefined type
0066   std::int32_t getType() const;
0067
0068   /// Access the PDG code of this id - ( 999999 ) if unknown
0069   std::int32_t getPDG() const;
0070
0071   /// Access the type of the algorithm/module that created this hypothesis
0072   std::int32_t getAlgorithmType() const;
0073
0074   /// Access the likelihood of this hypothesis - in a user defined normalization
0075   float getLikelihood() const;
0076
0077   /// Access the the particle from which this PID has been computed
0078   const edm4hep::ReconstructedParticle getParticle() const;
0079
0080   /// Set the userdefined type
0081   void setType(std::int32_t value);
0082   /// Get mutable reference to userdefined type
0083   std::int32_t& getType();
0084   /// Get reference to userdefined type
0085   [[deprecated("use getType instead")]] std::int32_t& type();
0086
0087   /// Set the PDG code of this id - ( 999999 ) if unknown
0088   void setPDG(std::int32_t value);
0089   /// Get mutable reference to PDG code of this id - ( 999999 ) if unknown
0090   std::int32_t& getPDG();
0091   /// Get reference to PDG code of this id - ( 999999 ) if unknown
0092   [[deprecated("use getPDG instead")]] std::int32_t& PDG();
0093
0094   /// Set the type of the algorithm/module that created this hypothesis
0095   void setAlgorithmType(std::int32_t value);
0096   /// Get mutable reference to type of the algorithm/module that created this hypothesis
0097   std::int32_t& getAlgorithmType();
0098   /// Get reference to type of the algorithm/module that created this hypothesis
0099   [[deprecated("use getAlgorithmType instead")]] std::int32_t& algorithmType();
0100
0101   /// Set the likelihood of this hypothesis - in a user defined normalization
0102   void setLikelihood(float value);
0103   /// Get mutable reference to likelihood of this hypothesis - in a user defined normalization
0104   float& getLikelihood();
0105   /// Get reference to likelihood of this hypothesis - in a user defined normalization
0106   [[deprecated("use getLikelihood instead")]] float& likelihood();
0107
0108   /// Set the the particle from which this PID has been computed
0109   void setParticle(const edm4hep::ReconstructedParticle& value);
0110
0111   void addToParameters(const float&);
0112   std::size_t parameters_size() const;
0113   float getParameters(std::size_t) const;
0114   std::vector<float>::const_iterator parameters_begin() const;
0115   std::vector<float>::const_iterator parameters_end() const;
0116   podio::RelationRange<float> getParameters() const;
0117
0118   /// check whether the object is actually available
0119   bool isAvailable() const;
0120   /// disconnect from ParticleIDObj instance
0121   void unlink() {
0122     m_obj = podio::utils::MaybeSharedPtr<ParticleIDObj>{nullptr};
0123   }
0124
0125   bool operator==(const MutableParticleID& other) const {
0126     return m_obj == other.m_obj;
0127   }
0128   bool operator==(const ParticleID& other) const;
0129
0130   bool operator!=(const MutableParticleID& other) const {
0131     return !(*this == other);
0132   }
0133   bool operator!=(const ParticleID& other) const {
0134     return !(*this == other);
0135   }
0136
0137   // less comparison operator, so that objects can be e.g. stored in sets.
0138   bool operator<(const MutableParticleID& other) const {
0139     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0140   }
0141
0142   podio::ObjectID id() const {
0143     return getObjectID();
0144   }
0145
0146   const podio::ObjectID getObjectID() const;
0147
0148   friend void swap(MutableParticleID& a, MutableParticleID& b) {
0149     using std::swap;
0150     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0151   }
0152
0153 private:
0154   /// constructor from existing ParticleIDObj
0155   explicit MutableParticleID(podio::utils::MaybeSharedPtr<ParticleIDObj> obj);
0156
0157   podio::utils::MaybeSharedPtr<ParticleIDObj> m_obj{nullptr};
0158 };
0159
0160 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0161 void to_json(nlohmann::json& j, const MutableParticleID& value);
0162 #endif
0163
0164 } // namespace edm4hep
0165
0166 #endif