MutableTrackParameters.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MutableTrackParameters_H
#define EICD_MutableTrackParameters_H
 
#include "eicd/TrackParametersObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "eicd/TrackParameters.h"
 
#include "eicd/Cov2f.h"
#include "eicd/Cov3f.h"
#include "edm4hep/Vector2f.h"
#include <cstdint>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
// forward declarations
namespace eicd {
class Trajectory;
class MutableTrajectory;
}
 
 
namespace eicd {
 
 
/** @class MutableTrackParameters
 *  ACTS Bound Track parameters
 *  @author: W. Armstrong, S. Joosten
 */
class MutableTrackParameters {
 
  friend class TrackParametersCollection;
  friend class TrackParametersMutableCollectionIterator;
  friend class TrackParameters;
 
public:
 
  /// default constructor
  MutableTrackParameters();
  MutableTrackParameters(std::int32_t type, edm4hep::Vector2f loc, eicd::Cov2f locError, float theta, float phi, float qOverP, eicd::Cov3f momentumError, float time, float timeError, float charge);
 
  /// constructor from existing TrackParametersObj
  MutableTrackParameters(TrackParametersObj* obj);
 
  /// copy constructor
  MutableTrackParameters(const MutableTrackParameters& other);
 
  /// copy-assignment operator
  MutableTrackParameters& operator=(MutableTrackParameters other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableTrackParameters clone() const;
 
  /// destructor
  ~MutableTrackParameters();
 
  /// conversion to const object
  operator TrackParameters() const;
 
public:
 
  /// Access the Type of track parameters (-1/seed, 0/head, ...)
  const std::int32_t& getType() const;
 
  /// Access the 2D location on surface
  const edm4hep::Vector2f& getLoc() const;
 
  /// Access the Covariance on loc
  const eicd::Cov2f& getLocError() const;
 
  /// Access the Track polar angle [rad]
  const float& getTheta() const;
 
  /// Access the Track azimuthal angle [rad]
  const float& getPhi() const;
 
  /// Access the [e/GeV]
  const float& getQOverP() const;
 
  /// Access the Covariance on theta, phi and qOverP
  const eicd::Cov3f& getMomentumError() const;
 
  /// Access the Track time [ns]
  const float& getTime() const;
 
  /// Access the Error on the time
  const float& getTimeError() const;
 
  /// Access the Particle charge
  const float& getCharge() const;
 
 
  /// Access the Trajectory associated with these track parameters
  const eicd::Trajectory getTrajectory() const;
 
  /// Set the Type of track parameters (-1/seed, 0/head, ...)
  void setType(std::int32_t value);
 
  /// Set the 2D location on surface
  void setLoc(edm4hep::Vector2f value);
  /// Get reference to 2D location on surface
  edm4hep::Vector2f& loc();
 
  /// Set the Covariance on loc
  void setLocError(eicd::Cov2f value);
  /// Get reference to Covariance on loc
  eicd::Cov2f& locError();
 
  /// Set the Track polar angle [rad]
  void setTheta(float value);
 
  /// Set the Track azimuthal angle [rad]
  void setPhi(float value);
 
  /// Set the [e/GeV]
  void setQOverP(float value);
 
  /// Set the Covariance on theta, phi and qOverP
  void setMomentumError(eicd::Cov3f value);
  /// Get reference to Covariance on theta, phi and qOverP
  eicd::Cov3f& momentumError();
 
  /// Set the Track time [ns]
  void setTime(float value);
 
  /// Set the Error on the time
  void setTimeError(float value);
 
  /// Set the Particle charge
  void setCharge(float value);
 
 
  /// Set the Trajectory associated with these track parameters
  void setTrajectory(eicd::Trajectory value);
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackParametersObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MutableTrackParameters& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackParameters& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackParameters& 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(MutableTrackParameters& a, MutableTrackParameters& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  TrackParametersObj* m_obj;
};
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MutableTrackParameters& value);
#endif
 
 
} // namespace eicd
 
 
#endif