include/edm4eic/TrackSegment.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_TrackSegment_H
0004 #define EDM4EIC_TrackSegment_H
0005
0006 #include "edm4eic/TrackSegmentObj.h"
0007
0008 #include "edm4eic/TrackPoint.h"
0009 #include "podio/RelationRange.h"
0010 #include <vector>
0011
0012 #include "podio/utilities/MaybeSharedPtr.h"
0013 #include "podio/detail/OrderKey.h"
0014
0015 #include <ostream>
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 TrackSegmentCollection;
0025 class Track;
0026 class MutableTrack;
0027 }
0028
0029
0030 namespace podio::detail {
0031 // Internal function used in less comparison operators of the datatypes and interface types
0032 OrderKey getOrderKey(const edm4eic::TrackSegment& obj);
0033 };
0034
0035 namespace edm4eic {
0036
0037 class MutableTrackSegment;
0038 class TrackSegmentCollection;
0039 class TrackSegmentCollectionData;
0040
0041 /** @class TrackSegment
0042  *  A track segment defined by one or more points along a track.
0043  *  @author: S. Joosten
0044  */
0045 class TrackSegment {
0046
0047   friend class MutableTrackSegment;
0048   friend class TrackSegmentCollection;
0049   friend class edm4eic::TrackSegmentCollectionData;
0050   friend class TrackSegmentCollectionIterator;
0051   friend podio::detail::OrderKey podio::detail::getOrderKey(const TrackSegment & obj);
0052
0053 public:
0054   using mutable_type = MutableTrackSegment;
0055   using collection_type = TrackSegmentCollection;
0056
0057   /// default constructor
0058   TrackSegment();
0059
0060   /// Constructor initializing all members
0061   TrackSegment(float length, float lengthError);
0062
0063   /// copy constructor
0064   TrackSegment(const TrackSegment& other) = default;
0065
0066   /// copy-assignment operator
0067   TrackSegment& operator=(TrackSegment other);
0068
0069   /// create a mutable deep-copy of the object with identical relations
0070   /// if cloneRelations=false, the relations are not cloned and will be empty
0071   MutableTrackSegment clone(bool cloneRelations=true) const;
0072
0073   /// destructor
0074   ~TrackSegment() = default;
0075
0076   /// converting constructor from mutable object
0077   TrackSegment(const MutableTrackSegment& other);
0078
0079   static TrackSegment makeEmpty();
0080
0081 public:
0082
0083   static constexpr auto typeName = "edm4eic::TrackSegment";
0084
0085   /// Access the Pathlength from the first to the last point
0086   float getLength() const;
0087
0088   /// Access the Error on the segment length
0089   float getLengthError() const;
0090
0091
0092   /// Access the Track used for this projection
0093   const edm4eic::Track getTrack() const;
0094
0095   std::size_t points_size() const;
0096   edm4eic::TrackPoint getPoints(std::size_t) const;
0097   std::vector<edm4eic::TrackPoint>::const_iterator points_begin() const;
0098   std::vector<edm4eic::TrackPoint>::const_iterator points_end() const;
0099   podio::RelationRange<edm4eic::TrackPoint> getPoints() const;
0100
0101
0102   /// check whether the object is actually available
0103   bool isAvailable() const;
0104   /// disconnect from TrackSegmentObj instance
0105   void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackSegmentObj>{nullptr}; }
0106
0107   bool operator==(const TrackSegment& other) const { return m_obj == other.m_obj; }
0108   bool operator==(const MutableTrackSegment& other) const;
0109
0110   bool operator!=(const TrackSegment& other) const { return !(*this == other); }
0111   bool operator!=(const MutableTrackSegment& other) const { return !(*this == other); }
0112
0113   // less comparison operator, so that objects can be e.g. stored in sets.
0114   bool operator<(const TrackSegment& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0115
0116   podio::ObjectID id() const { return getObjectID(); }
0117
0118   const podio::ObjectID getObjectID() const;
0119
0120   friend void swap(TrackSegment& a, TrackSegment& b) {
0121     using std::swap;
0122     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0123   }
0124
0125 private:
0126   /// constructor from existing TrackSegmentObj
0127   explicit TrackSegment(podio::utils::MaybeSharedPtr<TrackSegmentObj> obj);
0128   TrackSegment(TrackSegmentObj* obj);
0129
0130   podio::utils::MaybeSharedPtr<TrackSegmentObj> m_obj{nullptr};
0131 };
0132
0133 std::ostream& operator<<(std::ostream& o, const TrackSegment& value);
0134
0135 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0136 void to_json(nlohmann::json& j, const TrackSegment& value);
0137 #endif
0138
0139
0140 } // namespace edm4eic
0141
0142
0143 #endif