include/edm4eic/MutableTrackParameters.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableTrackParameters_H
0004 #define EDM4EIC_MutableTrackParameters_H
0005
0006 #include "edm4eic/TrackParametersObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/TrackParameters.h"
0009
0010 #include "edm4eic/Cov6f.h"
0011 #include "edm4hep/Vector2f.h"
0012 #include <cstdint>
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 edm4eic {
0024 class TrackParametersCollection;
0025 }
0026
0027
0028 namespace edm4eic {
0029
0030
0031 /** @class MutableTrackParameters
0032  *  ACTS Bound Track parameters
0033  *  @author: W. Armstrong, S. Joosten, J. Osborn
0034  */
0035 class MutableTrackParameters {
0036
0037   friend class TrackParametersCollection;
0038   friend class TrackParametersMutableCollectionIterator;
0039   friend class TrackParameters;
0040
0041 public:
0042   using object_type = TrackParameters;
0043   using collection_type = TrackParametersCollection;
0044
0045   /// default constructor
0046   MutableTrackParameters() = default;
0047
0048   /// Constructor initializing all members
0049   MutableTrackParameters(const std::int32_t type, const std::uint64_t surface, const edm4hep::Vector2f& loc, const float phi, const float theta, const float qOverP, const float time, const std::int32_t pdg, const edm4eic::Cov6f& covariance);
0050
0051   /// copy constructor
0052   MutableTrackParameters(const MutableTrackParameters& other) = default;
0053
0054   /// copy-assignment operator
0055   MutableTrackParameters& operator=(MutableTrackParameters other) &; // Rebind this to other's internal object
0056   MutableTrackParameters& operator=(MutableTrackParameters other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
0057
0058   /// create a mutable deep-copy of the object with identical relations
0059   /// if cloneRelations=false, the relations are not cloned and will be empty
0060   MutableTrackParameters clone(bool cloneRelations=true) const;
0061
0062   /// destructor
0063   ~MutableTrackParameters() = default;
0064
0065
0066 public:
0067
0068   /// Access the Type of track parameters (-1/seed, 0/head, ...)
0069   std::int32_t getType() const;
0070
0071   /// Access the Surface for bound parameters (geometryID)
0072   std::uint64_t getSurface() const;
0073
0074   /// Access the 2D location on surface
0075   const edm4hep::Vector2f& getLoc() const;
0076
0077   /// Access the Track azimuthal angle [rad]
0078   float getPhi() const;
0079
0080   /// Access the Track polar angle [rad]
0081   float getTheta() const;
0082
0083   /// Access the [e/GeV]
0084   float getQOverP() const;
0085
0086   /// Access the Track time [ns]
0087   float getTime() const;
0088
0089   /// Access the pdg pid for these parameters
0090   std::int32_t getPdg() const;
0091
0092   /// Access the Full covariance in basis following ACTS convention [l0,l1,phi,theta,q/p,t]
0093   const edm4eic::Cov6f& getCovariance() const;
0094
0095
0096
0097   /// Set the Type of track parameters (-1/seed, 0/head, ...)
0098   void setType(const std::int32_t type);
0099   /// Get mutable reference to Type of track parameters (-1/seed, 0/head, ...)
0100   std::int32_t& getType();
0101
0102   /// Set the Surface for bound parameters (geometryID)
0103   void setSurface(const std::uint64_t surface);
0104   /// Get mutable reference to Surface for bound parameters (geometryID)
0105   std::uint64_t& getSurface();
0106
0107   /// Set the 2D location on surface
0108   void setLoc(const edm4hep::Vector2f& loc);
0109   /// Get mutable reference to 2D location on surface
0110   edm4hep::Vector2f& getLoc();
0111
0112   /// Set the Track azimuthal angle [rad]
0113   void setPhi(const float phi);
0114   /// Get mutable reference to Track azimuthal angle [rad]
0115   float& getPhi();
0116
0117   /// Set the Track polar angle [rad]
0118   void setTheta(const float theta);
0119   /// Get mutable reference to Track polar angle [rad]
0120   float& getTheta();
0121
0122   /// Set the [e/GeV]
0123   void setQOverP(const float qOverP);
0124   /// Get mutable reference to [e/GeV]
0125   float& getQOverP();
0126
0127   /// Set the Track time [ns]
0128   void setTime(const float time);
0129   /// Get mutable reference to Track time [ns]
0130   float& getTime();
0131
0132   /// Set the pdg pid for these parameters
0133   void setPdg(const std::int32_t pdg);
0134   /// Get mutable reference to pdg pid for these parameters
0135   std::int32_t& getPdg();
0136
0137   /// Set the Full covariance in basis following ACTS convention [l0,l1,phi,theta,q/p,t]
0138   void setCovariance(const edm4eic::Cov6f& covariance);
0139   /// Get mutable reference to Full covariance in basis following ACTS convention [l0,l1,phi,theta,q/p,t]
0140   edm4eic::Cov6f& getCovariance();
0141
0142
0143
0144
0145
0146
0147   /// check whether the object is actually available
0148   bool isAvailable() const;
0149   /// disconnect from TrackParametersObj instance
0150   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackParametersObj>{nullptr}; }
0151
0152   constexpr bool operator==(const MutableTrackParameters& other) const { return m_obj == other.m_obj; }
0153   bool operator==(const TrackParameters& other) const;
0154
0155   constexpr bool operator!=(const MutableTrackParameters& other) const { return !(*this == other); }
0156   bool operator!=(const TrackParameters& other) const { return !(*this == other); }
0157
0158   // less comparison operator, so that objects can be e.g. stored in sets.
0159   bool operator<(const MutableTrackParameters& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0160
0161   podio::ObjectID id() const { return getObjectID(); }
0162
0163   const podio::ObjectID getObjectID() const;
0164
0165   friend std::hash<MutableTrackParameters>;
0166
0167   friend void swap(MutableTrackParameters& a, MutableTrackParameters& b) {
0168     using std::swap;
0169     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0170   }
0171
0172 private:
0173   /// constructor from existing TrackParametersObj
0174   explicit MutableTrackParameters(podio::utils::MaybeSharedPtr<TrackParametersObj> obj);
0175
0176   podio::utils::MaybeSharedPtr<TrackParametersObj> m_obj{new TrackParametersObj{}, podio::utils::MarkOwned};
0177 };
0178
0179 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0180 void to_json(nlohmann::json& j, const MutableTrackParameters& value);
0181 #endif
0182
0183
0184 } // namespace edm4eic
0185
0186
0187
0188 template<>
0189 struct std::hash<edm4eic::MutableTrackParameters> {
0190   std::size_t operator()(const edm4eic::MutableTrackParameters& obj) const {
0191     return std::hash<edm4eic::TrackParametersObj*>{}(obj.m_obj.get());
0192   }
0193 };
0194
0195
0196 #endif