include/edm4eic/MutableTrackSeed.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_MutableTrackSeed_H
0004 #define EDM4EIC_MutableTrackSeed_H
0005
0006 #include "edm4eic/TrackSeedObj.h"
0007 // Make the immutable class available from its mutable version but not vice versa
0008 #include "edm4eic/TrackSeed.h"
0009
0010 #include "edm4eic/TrackerHit.h"
0011 #include "edm4hep/Vector3f.h"
0012 #include "podio/RelationRange.h"
0013 #include <vector>
0014
0015 #include "podio/utilities/MaybeSharedPtr.h"
0016
0017 #include <cstdint>
0018
0019 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0020 #include "nlohmann/json_fwd.hpp"
0021 #endif
0022
0023 // forward declarations
0024 namespace edm4eic {
0025 class TrackSeedCollection;
0026 class TrackParameters;
0027 class MutableTrackParameters;
0028 }
0029
0030
0031 namespace edm4eic {
0032
0033
0034 /** @class MutableTrackSeed
0035  *  Seed info from the realistic seed finder
0036  *  @author: S. Li, B. Schmookler, J. Osborn
0037  */
0038 class MutableTrackSeed {
0039
0040   friend class TrackSeedCollection;
0041   friend class TrackSeedMutableCollectionIterator;
0042   friend class TrackSeed;
0043
0044 public:
0045   using object_type = TrackSeed;
0046   using collection_type = TrackSeedCollection;
0047
0048   /// default constructor
0049   MutableTrackSeed();
0050
0051   /// Constructor initializing all members
0052   MutableTrackSeed(edm4hep::Vector3f perigee);
0053
0054   /// copy constructor
0055   MutableTrackSeed(const MutableTrackSeed& other) = default;
0056
0057   /// copy-assignment operator
0058   MutableTrackSeed& operator=(MutableTrackSeed other);
0059
0060   /// create a mutable deep-copy of the object with identical relations
0061   /// if cloneRelations=false, the relations are not cloned and will be empty
0062   MutableTrackSeed clone(bool cloneRelations=true) const;
0063
0064   /// destructor
0065   ~MutableTrackSeed() = default;
0066
0067
0068 public:
0069
0070   /// Access the Vector for the perigee (line surface)
0071   const edm4hep::Vector3f& getPerigee() const;
0072
0073
0074   /// Access the Initial track parameters
0075   const edm4eic::TrackParameters getParams() const;
0076
0077   /// Set the Vector for the perigee (line surface)
0078   void setPerigee(edm4hep::Vector3f value);
0079   /// Get mutable reference to Vector for the perigee (line surface)
0080   edm4hep::Vector3f& getPerigee();
0081   /// Get reference to Vector for the perigee (line surface)
0082   [[deprecated("use getPerigee instead")]]
0083   edm4hep::Vector3f& perigee();
0084
0085
0086   /// Set the Initial track parameters
0087   void setParams(const edm4eic::TrackParameters& value);
0088
0089   void addToHits(const edm4eic::TrackerHit&);
0090   std::size_t hits_size() const;
0091   edm4eic::TrackerHit getHits(std::size_t) const;
0092   std::vector<edm4eic::TrackerHit>::const_iterator hits_begin() const;
0093   std::vector<edm4eic::TrackerHit>::const_iterator hits_end() const;
0094   podio::RelationRange<edm4eic::TrackerHit> getHits() const;
0095
0096
0097
0098   /// check whether the object is actually available
0099   bool isAvailable() const;
0100   /// disconnect from TrackSeedObj instance
0101   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackSeedObj>{nullptr}; }
0102
0103   bool operator==(const MutableTrackSeed& other) const { return m_obj == other.m_obj; }
0104   bool operator==(const TrackSeed& other) const;
0105
0106   bool operator!=(const MutableTrackSeed& other) const { return !(*this == other); }
0107   bool operator!=(const TrackSeed& other) const { return !(*this == other); }
0108
0109   // less comparison operator, so that objects can be e.g. stored in sets.
0110   bool operator<(const MutableTrackSeed& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0111
0112   podio::ObjectID id() const { return getObjectID(); }
0113
0114   const podio::ObjectID getObjectID() const;
0115
0116   friend void swap(MutableTrackSeed& a, MutableTrackSeed& b) {
0117     using std::swap;
0118     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0119   }
0120
0121 private:
0122   /// constructor from existing TrackSeedObj
0123   explicit MutableTrackSeed(podio::utils::MaybeSharedPtr<TrackSeedObj> obj);
0124
0125   podio::utils::MaybeSharedPtr<TrackSeedObj> m_obj{nullptr};
0126 };
0127
0128 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0129 void to_json(nlohmann::json& j, const MutableTrackSeed& value);
0130 #endif
0131
0132
0133 } // namespace edm4eic
0134
0135
0136 #endif