include/edm4eic/TrackSeed.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_TrackSeed_H
0004 #define EDM4EIC_TrackSeed_H
0005
0006 #include "edm4eic/TrackSeedObj.h"
0007
0008 #include "edm4eic/TrackerHit.h"
0009 #include "edm4hep/Vector3f.h"
0010 #include "podio/RelationRange.h"
0011 #include <vector>
0012
0013 #include "podio/utilities/MaybeSharedPtr.h"
0014 #include "podio/detail/OrderKey.h"
0015
0016 #include <ostream>
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 podio::detail {
0032 // Internal function used in less comparison operators of the datatypes and interface types
0033 OrderKey getOrderKey(const edm4eic::TrackSeed& obj);
0034 };
0035
0036 namespace edm4eic {
0037
0038 class MutableTrackSeed;
0039 class TrackSeedCollection;
0040 class TrackSeedCollectionData;
0041
0042 /** @class TrackSeed
0043  *  Seed info from the realistic seed finder
0044  *  @author: S. Li, B. Schmookler, J. Osborn
0045  */
0046 class TrackSeed {
0047
0048   friend class MutableTrackSeed;
0049   friend class TrackSeedCollection;
0050   friend class edm4eic::TrackSeedCollectionData;
0051   friend class TrackSeedCollectionIterator;
0052   friend podio::detail::OrderKey podio::detail::getOrderKey(const TrackSeed & obj);
0053
0054 public:
0055   using mutable_type = MutableTrackSeed;
0056   using collection_type = TrackSeedCollection;
0057
0058   /// default constructor
0059   TrackSeed();
0060
0061   /// Constructor initializing all members
0062   TrackSeed(edm4hep::Vector3f perigee);
0063
0064   /// copy constructor
0065   TrackSeed(const TrackSeed& other) = default;
0066
0067   /// copy-assignment operator
0068   TrackSeed& operator=(TrackSeed other);
0069
0070   /// create a mutable deep-copy of the object with identical relations
0071   /// if cloneRelations=false, the relations are not cloned and will be empty
0072   MutableTrackSeed clone(bool cloneRelations=true) const;
0073
0074   /// destructor
0075   ~TrackSeed() = default;
0076
0077   /// converting constructor from mutable object
0078   TrackSeed(const MutableTrackSeed& other);
0079
0080   static TrackSeed makeEmpty();
0081
0082 public:
0083
0084   static constexpr auto typeName = "edm4eic::TrackSeed";
0085
0086   /// Access the Vector for the perigee (line surface)
0087   const edm4hep::Vector3f& getPerigee() const;
0088
0089
0090   /// Access the Initial track parameters
0091   const edm4eic::TrackParameters getParams() const;
0092
0093   std::size_t hits_size() const;
0094   edm4eic::TrackerHit getHits(std::size_t) const;
0095   std::vector<edm4eic::TrackerHit>::const_iterator hits_begin() const;
0096   std::vector<edm4eic::TrackerHit>::const_iterator hits_end() const;
0097   podio::RelationRange<edm4eic::TrackerHit> getHits() const;
0098
0099
0100   /// check whether the object is actually available
0101   bool isAvailable() const;
0102   /// disconnect from TrackSeedObj instance
0103   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackSeedObj>{nullptr}; }
0104
0105   bool operator==(const TrackSeed& other) const { return m_obj == other.m_obj; }
0106   bool operator==(const MutableTrackSeed& other) const;
0107
0108   bool operator!=(const TrackSeed& other) const { return !(*this == other); }
0109   bool operator!=(const MutableTrackSeed& other) const { return !(*this == other); }
0110
0111   // less comparison operator, so that objects can be e.g. stored in sets.
0112   bool operator<(const TrackSeed& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0113
0114   podio::ObjectID id() const { return getObjectID(); }
0115
0116   const podio::ObjectID getObjectID() const;
0117
0118   friend void swap(TrackSeed& a, TrackSeed& b) {
0119     using std::swap;
0120     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0121   }
0122
0123 private:
0124   /// constructor from existing TrackSeedObj
0125   explicit TrackSeed(podio::utils::MaybeSharedPtr<TrackSeedObj> obj);
0126   TrackSeed(TrackSeedObj* obj);
0127
0128   podio::utils::MaybeSharedPtr<TrackSeedObj> m_obj{nullptr};
0129 };
0130
0131 std::ostream& operator<<(std::ostream& o, const TrackSeed& value);
0132
0133 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0134 void to_json(nlohmann::json& j, const TrackSeed& value);
0135 #endif
0136
0137
0138 } // namespace edm4eic
0139
0140
0141 #endif