MutableTrack.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MutableTrack_H
#define EICD_MutableTrack_H
 
#include "eicd/TrackObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "eicd/Track.h"
 
#include "eicd/Cov3f.h"
#include "eicd/TrackParameters.h"
#include "eicd/TrackerHit.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
 
 
namespace eicd {
 
 
/** @class MutableTrack
 *  Track information at the vertex
 *  @author: S. Joosten
 */
class MutableTrack {
 
  friend class TrackCollection;
  friend class TrackMutableCollectionIterator;
  friend class Track;
 
public:
 
  /// default constructor
  MutableTrack();
  MutableTrack(std::int32_t type, float chi2, std::int32_t ndf, edm4hep::Vector3f momentum, eicd::Cov3f momentumError, float time, float timeError, float charge);
 
  /// constructor from existing TrackObj
  MutableTrack(TrackObj* obj);
 
  /// copy constructor
  MutableTrack(const MutableTrack& other);
 
  /// copy-assignment operator
  MutableTrack& operator=(MutableTrack other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableTrack clone() const;
 
  /// destructor
  ~MutableTrack();
 
  /// conversion to const object
  operator Track() const;
 
public:
 
  /// Access the Flag that defines the type of track
  const std::int32_t& getType() const;
 
  /// Access the Total chi2 (sum) of the track fit
  const float& getChi2() const;
 
  /// Access the Numbers of degrees of freedom of the track fit
  const std::int32_t& getNdf() const;
 
  /// Access the Track 3-momentum at the vertex [GeV]
  const edm4hep::Vector3f& getMomentum() const;
 
  /// Access the Covariance matrix on the momentum
  const eicd::Cov3f& getMomentumError() const;
 
  /// Access the Track time at the vertex [ns]
  const float& getTime() const;
 
  /// Access the Error on the track vertex time
  const float& getTimeError() const;
 
  /// Access the Particle charge
  const float& getCharge() const;
 
 
 
  /// Set the Flag that defines the type of track
  void setType(std::int32_t value);
 
  /// Set the Total chi2 (sum) of the track fit
  void setChi2(float value);
 
  /// Set the Numbers of degrees of freedom of the track fit
  void setNdf(std::int32_t value);
 
  /// Set the Track 3-momentum at the vertex [GeV]
  void setMomentum(edm4hep::Vector3f value);
  /// Get reference to Track 3-momentum at the vertex [GeV]
  edm4hep::Vector3f& momentum();
 
  /// Set the Covariance matrix on the momentum
  void setMomentumError(eicd::Cov3f value);
  /// Get reference to Covariance matrix on the momentum
  eicd::Cov3f& momentumError();
 
  /// Set the Track time at the vertex [ns]
  void setTime(float value);
 
  /// Set the Error on the track vertex time
  void setTimeError(float value);
 
  /// Set the Particle charge
  void setCharge(float value);
 
 
 
  void addToParameters(eicd::TrackParameters);
  unsigned int parameters_size() const;
  eicd::TrackParameters getParameters(unsigned int) const;
  std::vector<eicd::TrackParameters>::const_iterator parameters_begin() const;
  std::vector<eicd::TrackParameters>::const_iterator parameters_end() const;
  podio::RelationRange<eicd::TrackParameters> getParameters() const;
  void addToTrackerHits(eicd::TrackerHit);
  unsigned int trackerHits_size() const;
  eicd::TrackerHit getTrackerHits(unsigned int) const;
  std::vector<eicd::TrackerHit>::const_iterator trackerHits_begin() const;
  std::vector<eicd::TrackerHit>::const_iterator trackerHits_end() const;
  podio::RelationRange<eicd::TrackerHit> getTrackerHits() const;
  void addToTracks(eicd::Track);
  unsigned int tracks_size() const;
  eicd::Track getTracks(unsigned int) const;
  std::vector<eicd::Track>::const_iterator tracks_begin() const;
  std::vector<eicd::Track>::const_iterator tracks_end() const;
  podio::RelationRange<eicd::Track> getTracks() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MutableTrack& other) const { return m_obj == other.m_obj; }
  bool operator==(const Track& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrack& 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(MutableTrack& a, MutableTrack& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  TrackObj* m_obj;
};
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MutableTrack& value);
#endif
 
 
} // namespace eicd
 
 
#endif