include/edm4hep/MutableTrackerHitPlane.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4HEP_MutableTrackerHitPlane_H
0004 #define EDM4HEP_MutableTrackerHitPlane_H
0005
0006 #include "edm4hep/TrackerHitPlaneObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4hep/TrackerHitPlane.h"
0009
0010 #include "edm4hep/CovMatrix3f.h"
0011 #include "edm4hep/Vector2f.h"
0012 #include "edm4hep/Vector3d.h"
0013 #include <cstdint>
0014 #include <edm4hep/Constants.h>
0015
0016 #include "podio/utilities/MaybeSharedPtr.h"
0017
0018 #include <cstdint>
0019
0020 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0021 #include "nlohmann/json_fwd.hpp"
0022 #endif
0023
0024 // forward declarations
0025 namespace edm4hep {
0026 class TrackerHitPlaneCollection;
0027 class TrackerHit;
0028 } // namespace edm4hep
0029
0030 namespace edm4hep {
0031
0032 /** @class MutableTrackerHitPlane
0033  *  Tracker hit plane
0034  *  @author: EDM4hep authors
0035  */
0036 class MutableTrackerHitPlane {
0037
0038   friend class TrackerHitPlaneCollection;
0039   friend class TrackerHitPlaneMutableCollectionIterator;
0040   friend class TrackerHitPlane;
0041
0042 public:
0043   using object_type = TrackerHitPlane;
0044   using collection_type = TrackerHitPlaneCollection;
0045
0046   /// default constructor
0047   MutableTrackerHitPlane() = default;
0048
0049   /// Constructor initializing all members
0050   MutableTrackerHitPlane(const std::uint64_t cellID, const std::int32_t type, const std::int32_t quality,
0051                          const float time, const float eDep, const float eDepError, const edm4hep::Vector2f& u,
0052                          const edm4hep::Vector2f& v, const float du, const float dv, const edm4hep::Vector3d& position,
0053                          const edm4hep::CovMatrix3f& covMatrix);
0054
0055   /// copy constructor
0056   MutableTrackerHitPlane(const MutableTrackerHitPlane& other) = default;
0057
0058   /// copy-assignment operator
0059   MutableTrackerHitPlane& operator=(MutableTrackerHitPlane other) &; // Rebind this to other's internal object
0060   MutableTrackerHitPlane&
0061   operator=(MutableTrackerHitPlane 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   MutableTrackerHitPlane clone(bool cloneRelations = true) const;
0066
0067   /// destructor
0068   ~MutableTrackerHitPlane() = default;
0069
0070 public:
0071   /// Access the ID of the sensor that created this hit
0072   std::uint64_t getCellID() const;
0073
0074   /// Access the type of raw data hit
0075   std::int32_t getType() const;
0076
0077   /// Access the quality bit flag of the hit
0078   std::int32_t getQuality() const;
0079
0080   /// Access the time of the hit [ns]
0081   float getTime() const;
0082
0083   /// Access the energy deposited on the hit [GeV]
0084   float getEDep() const;
0085
0086   /// Access the error measured on eDep [GeV]
0087   float getEDepError() const;
0088
0089   /// Access the direction of the first measurement given as (theta, phi) in spherical coordinates [rad]
0090   const edm4hep::Vector2f& getU() const;
0091
0092   /// Access the direction of the second measurement given as (theta, phi) in spherical coordinates [rad]
0093   const edm4hep::Vector2f& getV() const;
0094
0095   /// Access the measurement error along the direction [mm]
0096   float getDu() const;
0097
0098   /// Access the measurement error along the direction [mm]
0099   float getDv() const;
0100
0101   /// Access the hit position [mm]
0102   const edm4hep::Vector3d& getPosition() const;
0103
0104   /// Access the covariance of the position (x,y,z) [mm^2]
0105   const edm4hep::CovMatrix3f& getCovMatrix() const;
0106
0107   /// Set the ID of the sensor that created this hit
0108   void setCellID(const std::uint64_t cellID);
0109   /// Get mutable reference to ID of the sensor that created this hit
0110   std::uint64_t& getCellID();
0111
0112   /// Set the type of raw data hit
0113   void setType(const std::int32_t type);
0114   /// Get mutable reference to type of raw data hit
0115   std::int32_t& getType();
0116
0117   /// Set the quality bit flag of the hit
0118   void setQuality(const std::int32_t quality);
0119   /// Get mutable reference to quality bit flag of the hit
0120   std::int32_t& getQuality();
0121
0122   /// Set the time of the hit [ns]
0123   void setTime(const float time);
0124   /// Get mutable reference to time of the hit [ns]
0125   float& getTime();
0126
0127   /// Set the energy deposited on the hit [GeV]
0128   void setEDep(const float eDep);
0129   /// Get mutable reference to energy deposited on the hit [GeV]
0130   float& getEDep();
0131
0132   /// Set the error measured on eDep [GeV]
0133   void setEDepError(const float eDepError);
0134   /// Get mutable reference to error measured on eDep [GeV]
0135   float& getEDepError();
0136
0137   /// Set the direction of the first measurement given as (theta, phi) in spherical coordinates [rad]
0138   void setU(const edm4hep::Vector2f& u);
0139   /// Get mutable reference to direction of the first measurement given as (theta, phi) in spherical coordinates [rad]
0140   edm4hep::Vector2f& getU();
0141
0142   /// Set the direction of the second measurement given as (theta, phi) in spherical coordinates [rad]
0143   void setV(const edm4hep::Vector2f& v);
0144   /// Get mutable reference to direction of the second measurement given as (theta, phi) in spherical coordinates [rad]
0145   edm4hep::Vector2f& getV();
0146
0147   /// Set the measurement error along the direction [mm]
0148   void setDu(const float du);
0149   /// Get mutable reference to measurement error along the direction [mm]
0150   float& getDu();
0151
0152   /// Set the measurement error along the direction [mm]
0153   void setDv(const float dv);
0154   /// Get mutable reference to measurement error along the direction [mm]
0155   float& getDv();
0156
0157   /// Set the hit position [mm]
0158   void setPosition(const edm4hep::Vector3d& position);
0159   /// Get mutable reference to hit position [mm]
0160   edm4hep::Vector3d& getPosition();
0161
0162   /// Set the covariance of the position (x,y,z) [mm^2]
0163   void setCovMatrix(const edm4hep::CovMatrix3f& covMatrix);
0164   /// Get mutable reference to covariance of the position (x,y,z) [mm^2]
0165   edm4hep::CovMatrix3f& getCovMatrix();
0166
0167   /// Get the position covariance matrix value for the two passed dimensions
0168   float getCovMatrix(edm4hep::Cartesian dimI, edm4hep::Cartesian dimJ) const {
0169     return getCovMatrix().getValue(dimI, dimJ);
0170   }
0171
0172   /// Set the position covariance matrix value for the two passed dimensions
0173   void setCovMatrix(float value, edm4hep::Cartesian dimI, edm4hep::Cartesian dimJ) {
0174     getCovMatrix().setValue(value, dimI, dimJ);
0175   }
0176
0177   /// check whether the object is actually available
0178   bool isAvailable() const;
0179   /// disconnect from TrackerHitPlaneObj instance
0180   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackerHitPlaneObj>{nullptr}; }
0181
0182   constexpr bool operator==(const MutableTrackerHitPlane& other) const { return m_obj == other.m_obj; }
0183   bool operator==(const TrackerHitPlane& other) const;
0184
0185   constexpr bool operator!=(const MutableTrackerHitPlane& other) const { return !(*this == other); }
0186   bool operator!=(const TrackerHitPlane& other) const { return !(*this == other); }
0187
0188   // less comparison operator, so that objects can be e.g. stored in sets.
0189   bool operator<(const MutableTrackerHitPlane& other) const {
0190     return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other);
0191   }
0192
0193   podio::ObjectID id() const { return getObjectID(); }
0194
0195   const podio::ObjectID getObjectID() const;
0196
0197   friend std::hash<MutableTrackerHitPlane>;
0198
0199   friend void swap(MutableTrackerHitPlane& a, MutableTrackerHitPlane& b) {
0200     using std::swap;
0201     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0202   }
0203
0204 private:
0205   /// constructor from existing TrackerHitPlaneObj
0206   explicit MutableTrackerHitPlane(podio::utils::MaybeSharedPtr<TrackerHitPlaneObj> obj);
0207
0208   podio::utils::MaybeSharedPtr<TrackerHitPlaneObj> m_obj{new TrackerHitPlaneObj{}, podio::utils::MarkOwned};
0209 };
0210
0211 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0212 void to_json(nlohmann::json& j, const MutableTrackerHitPlane& value);
0213 #endif
0214
0215 } // namespace edm4hep
0216
0217 template <>
0218 struct std::hash<edm4hep::MutableTrackerHitPlane> {
0219   std::size_t operator()(const edm4hep::MutableTrackerHitPlane& obj) const {
0220     return std::hash<edm4hep::TrackerHitPlaneObj*>{}(obj.m_obj.get());
0221   }
0222 };
0223
0224 #endif