MutableTrackSegment.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MutableTrackSegment_H
#define EICD_MutableTrackSegment_H
 
#include "eicd/TrackSegmentObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "eicd/TrackSegment.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
 *  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:
 
  /// default constructor
  MutableTrackSegment();
  MutableTrackSegment(float length, float lengthError);
 
  /// constructor from existing TrackSegmentObj
  MutableTrackSegment(TrackSegmentObj* obj);
 
  /// copy constructor
  MutableTrackSegment(const MutableTrackSegment& other);
 
  /// copy-assignment operator
  MutableTrackSegment& operator=(MutableTrackSegment other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableTrackSegment clone() const;
 
  /// destructor
  ~MutableTrackSegment();
 
  /// conversion to const object
  operator TrackSegment() const;
 
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;
 
  /// Set the Pathlength from the first to the last point
  void setLength(float value);
 
  /// Set the Error on the segment length
  void setLengthError(float value);
 
 
  /// Set the Track used for this projection
  void setTrack(eicd::Track value);
 
  void addToPoints(eicd::TrackPoint);
  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 MutableTrackSegment& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackSegment& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackSegment& 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(MutableTrackSegment& a, MutableTrackSegment& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  TrackSegmentObj* m_obj;
};
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MutableTrackSegment& value);
#endif
 
 
} // namespace eicd
 
 
#endif