include/edm4eic/MutableRawTrackerHit.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableRawTrackerHit_H
0004 #define EDM4EIC_MutableRawTrackerHit_H
0005
0006 #include "edm4eic/RawTrackerHitObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/RawTrackerHit.h"
0009
0010 #include <cstdint>
0011
0012 #include "podio/utilities/MaybeSharedPtr.h"
0013
0014 #include <cstdint>
0015
0016 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0017 #include "nlohmann/json_fwd.hpp"
0018 #endif
0019
0020 // forward declarations
0021 namespace edm4eic {
0022 class RawTrackerHitCollection;
0023 }
0024
0025
0026 namespace edm4eic {
0027
0028
0029 /** @class MutableRawTrackerHit
0030  *  Raw (digitized) tracker hit
0031  *  @author: W. Armstrong, S. Joosten
0032  */
0033 class MutableRawTrackerHit {
0034
0035   friend class RawTrackerHitCollection;
0036   friend class RawTrackerHitMutableCollectionIterator;
0037   friend class RawTrackerHit;
0038
0039 public:
0040   using object_type = RawTrackerHit;
0041   using collection_type = RawTrackerHitCollection;
0042
0043   /// default constructor
0044   MutableRawTrackerHit();
0045
0046   /// Constructor initializing all members
0047   MutableRawTrackerHit(std::uint64_t cellID, std::int32_t charge, std::int32_t timeStamp);
0048
0049   /// copy constructor
0050   MutableRawTrackerHit(const MutableRawTrackerHit& other) = default;
0051
0052   /// copy-assignment operator
0053   MutableRawTrackerHit& operator=(MutableRawTrackerHit other);
0054
0055   /// create a mutable deep-copy of the object with identical relations
0056   /// if cloneRelations=false, the relations are not cloned and will be empty
0057   MutableRawTrackerHit clone(bool cloneRelations=true) const;
0058
0059   /// destructor
0060   ~MutableRawTrackerHit() = default;
0061
0062
0063 public:
0064
0065   /// Access the The detector specific (geometrical) cell id.
0066   std::uint64_t getCellID() const;
0067
0068   /// Access the ADC value
0069   std::int32_t getCharge() const;
0070
0071   /// Access the TDC value.
0072   std::int32_t getTimeStamp() const;
0073
0074
0075
0076   /// Set the The detector specific (geometrical) cell id.
0077   void setCellID(std::uint64_t value);
0078   /// Get mutable reference to The detector specific (geometrical) cell id.
0079   std::uint64_t& getCellID();
0080   /// Get reference to The detector specific (geometrical) cell id.
0081   [[deprecated("use getCellID instead")]]
0082   std::uint64_t& cellID();
0083
0084   /// Set the ADC value
0085   void setCharge(std::int32_t value);
0086   /// Get mutable reference to ADC value
0087   std::int32_t& getCharge();
0088   /// Get reference to ADC value
0089   [[deprecated("use getCharge instead")]]
0090   std::int32_t& charge();
0091
0092   /// Set the TDC value.
0093   void setTimeStamp(std::int32_t value);
0094   /// Get mutable reference to TDC value.
0095   std::int32_t& getTimeStamp();
0096   /// Get reference to TDC value.
0097   [[deprecated("use getTimeStamp instead")]]
0098   std::int32_t& timeStamp();
0099
0100
0101
0102
0103
0104
0105   /// check whether the object is actually available
0106   bool isAvailable() const;
0107   /// disconnect from RawTrackerHitObj instance
0108   void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr}; }
0109
0110   bool operator==(const MutableRawTrackerHit& other) const { return m_obj == other.m_obj; }
0111   bool operator==(const RawTrackerHit& other) const;
0112
0113   bool operator!=(const MutableRawTrackerHit& other) const { return !(*this == other); }
0114   bool operator!=(const RawTrackerHit& other) const { return !(*this == other); }
0115
0116   // less comparison operator, so that objects can be e.g. stored in sets.
0117   bool operator<(const MutableRawTrackerHit& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0118
0119   podio::ObjectID id() const { return getObjectID(); }
0120
0121   const podio::ObjectID getObjectID() const;
0122
0123   friend void swap(MutableRawTrackerHit& a, MutableRawTrackerHit& b) {
0124     using std::swap;
0125     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0126   }
0127
0128 private:
0129   /// constructor from existing RawTrackerHitObj
0130   explicit MutableRawTrackerHit(podio::utils::MaybeSharedPtr<RawTrackerHitObj> obj);
0131
0132   podio::utils::MaybeSharedPtr<RawTrackerHitObj> m_obj{nullptr};
0133 };
0134
0135 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0136 void to_json(nlohmann::json& j, const MutableRawTrackerHit& value);
0137 #endif
0138
0139
0140 } // namespace edm4eic
0141
0142
0143 #endif