TrackSegment.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_TrackSegment_H
#define EICD_TrackSegment_H
 
#include "eicd/TrackSegmentObj.h"
 
#include "eicd/TrackPoint.h"
#include "podio/RelationRange.h"
#include <vector>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
// forward declarations
namespace eicd {
class Track;
class MutableTrack;
}
 
 
namespace eicd {
 
class MutableTrackSegment;
 
/** @class TrackSegment
 *  A track segment defined by one or more points along a track.
 *  @author: S. Joosten
 */
class TrackSegment {
 
  friend class MutableTrackSegment;
  friend class TrackSegmentCollection;
  friend class TrackSegmentCollectionIterator;
 
public:
  /// default constructor
  TrackSegment();
  TrackSegment(float length, float lengthError);
 
  /// constructor from existing TrackSegmentObj
  TrackSegment(TrackSegmentObj* obj);
 
  /// copy constructor
  TrackSegment(const TrackSegment& other);
 
  /// copy-assignment operator
  TrackSegment& operator=(TrackSegment other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableTrackSegment clone() const;
 
  /// destructor
  ~TrackSegment();
 
 
public:
 
  /// Access the Pathlength from the first to the last point
  const float& getLength() const;
 
  /// Access the Error on the segment length
  const float& getLengthError() const;
 
 
  /// Access the Track used for this projection
  const eicd::Track getTrack() const;
 
  unsigned int points_size() const;
  eicd::TrackPoint getPoints(unsigned int) const;
  std::vector<eicd::TrackPoint>::const_iterator points_begin() const;
  std::vector<eicd::TrackPoint>::const_iterator points_end() const;
  podio::RelationRange<eicd::TrackPoint> getPoints() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackSegmentObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const TrackSegment& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTrackSegment& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const TrackSegment& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(TrackSegment& a, TrackSegment& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  TrackSegmentObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const TrackSegment& value);
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const TrackSegment& value);
#endif
 
 
} // namespace eicd
 
 
#endif