MutableTrackSegment.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrackSegment_H
#define EDM4EIC_MutableTrackSegment_H
 
#include "edm4eic/TrackSegmentObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/TrackSegment.h"
 
#include "edm4eic/TrackPoint.h"
#include "podio/RelationRange.h"
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class TrackSegmentCollection;
class Track;
class MutableTrack;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrackSegment
 *  A track segment defined by one or more points along a track.
 *  @author: S. Joosten
 */
class MutableTrackSegment {
 
  friend class TrackSegmentCollection;
  friend class TrackSegmentMutableCollectionIterator;
  friend class TrackSegment;
 
public:
  using object_type = TrackSegment;
  using collection_type = TrackSegmentCollection;
 
  /// default constructor
  MutableTrackSegment();
 
  /// Constructor initializing all members
  MutableTrackSegment(float length, float lengthError);
 
  /// copy constructor
  MutableTrackSegment(const MutableTrackSegment& other) = default;
 
  /// copy-assignment operator
  MutableTrackSegment& operator=(MutableTrackSegment other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackSegment clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrackSegment() = default;
 
 
public:
 
  /// Access the Pathlength from the first to the last point
  float getLength() const;
 
  /// Access the Error on the segment length
  float getLengthError() const;
 
 
  /// Access the Track used for this projection
  const edm4eic::Track getTrack() const;
 
  /// Set the Pathlength from the first to the last point
  void setLength(float value);
  /// Get mutable reference to Pathlength from the first to the last point
  float& getLength();
  /// Get reference to Pathlength from the first to the last point
  [[deprecated("use getLength instead")]]
  float& length();
 
  /// Set the Error on the segment length
  void setLengthError(float value);
  /// Get mutable reference to Error on the segment length
  float& getLengthError();
  /// Get reference to Error on the segment length
  [[deprecated("use getLengthError instead")]]
  float& lengthError();
 
 
  /// Set the Track used for this projection
  void setTrack(const edm4eic::Track& value);
 
  void addToPoints(const edm4eic::TrackPoint&);
  std::size_t points_size() const;
  edm4eic::TrackPoint getPoints(std::size_t) const;
  std::vector<edm4eic::TrackPoint>::const_iterator points_begin() const;
  std::vector<edm4eic::TrackPoint>::const_iterator points_end() const;
  podio::RelationRange<edm4eic::TrackPoint> getPoints() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackSegmentObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackSegmentObj>{nullptr}; }
 
  bool operator==(const MutableTrackSegment& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackSegment& other) const;
 
  bool operator!=(const MutableTrackSegment& other) const { return !(*this == other); }
  bool operator!=(const TrackSegment& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackSegment& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableTrackSegment& a, MutableTrackSegment& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackSegmentObj
  explicit MutableTrackSegment(podio::utils::MaybeSharedPtr<TrackSegmentObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackSegmentObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrackSegment& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif