MutableTrackParameters.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrackParameters_H
#define EDM4EIC_MutableTrackParameters_H
 
#include "edm4eic/TrackParametersObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/TrackParameters.h"
 
#include "edm4eic/Cov6f.h"
#include "edm4hep/Vector2f.h"
#include <cstdint>
 
#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 TrackParametersCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrackParameters
 *  ACTS Bound Track parameters
 *  @author: W. Armstrong, S. Joosten, J. Osborn
 */
class MutableTrackParameters {
 
  friend class TrackParametersCollection;
  friend class TrackParametersMutableCollectionIterator;
  friend class TrackParameters;
 
public:
  using object_type = TrackParameters;
  using collection_type = TrackParametersCollection;
 
  /// default constructor
  MutableTrackParameters();
 
  /// Constructor initializing all members
  MutableTrackParameters(const std::int32_t type, const std::uint64_t surface, const edm4hep::Vector2f& loc, const float theta, const float phi, const float qOverP, const float time, const std::int32_t pdg, const edm4eic::Cov6f& covariance);
 
  /// copy constructor
  MutableTrackParameters(const MutableTrackParameters& other) = default;
 
  /// copy-assignment operator
  MutableTrackParameters& operator=(MutableTrackParameters other) &; // Rebind this to other's internal object
  MutableTrackParameters& operator=(MutableTrackParameters other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackParameters clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrackParameters() = default;
 
 
public:
 
  /// Access the Type of track parameters (-1/seed, 0/head, ...)
  std::int32_t getType() const;
 
  /// Access the Surface for bound parameters (geometryID)
  std::uint64_t getSurface() const;
 
  /// Access the 2D location on surface
  const edm4hep::Vector2f& getLoc() const;
 
  /// Access the Track polar angle [rad]
  float getTheta() const;
 
  /// Access the Track azimuthal angle [rad]
  float getPhi() const;
 
  /// Access the [e/GeV]
  float getQOverP() const;
 
  /// Access the Track time [ns]
  float getTime() const;
 
  /// Access the pdg pid for these parameters
  std::int32_t getPdg() const;
 
  /// Access the Full covariance in basis [l0,l1,theta,phi,q/p,t]
  const edm4eic::Cov6f& getCovariance() const;
 
 
 
  /// Set the Type of track parameters (-1/seed, 0/head, ...)
  void setType(const std::int32_t type);
  /// Get mutable reference to Type of track parameters (-1/seed, 0/head, ...)
  std::int32_t& getType();
  /// Get reference to Type of track parameters (-1/seed, 0/head, ...)
  [[deprecated("use getType instead")]]
  std::int32_t& type();
 
  /// Set the Surface for bound parameters (geometryID)
  void setSurface(const std::uint64_t surface);
  /// Get mutable reference to Surface for bound parameters (geometryID)
  std::uint64_t& getSurface();
  /// Get reference to Surface for bound parameters (geometryID)
  [[deprecated("use getSurface instead")]]
  std::uint64_t& surface();
 
  /// Set the 2D location on surface
  void setLoc(const edm4hep::Vector2f& loc);
  /// Get mutable reference to 2D location on surface
  edm4hep::Vector2f& getLoc();
  /// Get reference to 2D location on surface
  [[deprecated("use getLoc instead")]]
  edm4hep::Vector2f& loc();
 
  /// Set the Track polar angle [rad]
  void setTheta(const float theta);
  /// Get mutable reference to Track polar angle [rad]
  float& getTheta();
  /// Get reference to Track polar angle [rad]
  [[deprecated("use getTheta instead")]]
  float& theta();
 
  /// Set the Track azimuthal angle [rad]
  void setPhi(const float phi);
  /// Get mutable reference to Track azimuthal angle [rad]
  float& getPhi();
  /// Get reference to Track azimuthal angle [rad]
  [[deprecated("use getPhi instead")]]
  float& phi();
 
  /// Set the [e/GeV]
  void setQOverP(const float qOverP);
  /// Get mutable reference to [e/GeV]
  float& getQOverP();
  /// Get reference to [e/GeV]
  [[deprecated("use getQOverP instead")]]
  float& qOverP();
 
  /// Set the Track time [ns]
  void setTime(const float time);
  /// Get mutable reference to Track time [ns]
  float& getTime();
  /// Get reference to Track time [ns]
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the pdg pid for these parameters
  void setPdg(const std::int32_t pdg);
  /// Get mutable reference to pdg pid for these parameters
  std::int32_t& getPdg();
  /// Get reference to pdg pid for these parameters
  [[deprecated("use getPdg instead")]]
  std::int32_t& pdg();
 
  /// Set the Full covariance in basis [l0,l1,theta,phi,q/p,t]
  void setCovariance(const edm4eic::Cov6f& covariance);
  /// Get mutable reference to Full covariance in basis [l0,l1,theta,phi,q/p,t]
  edm4eic::Cov6f& getCovariance();
  /// Get reference to Full covariance in basis [l0,l1,theta,phi,q/p,t]
  [[deprecated("use getCovariance instead")]]
  edm4eic::Cov6f& covariance();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackParametersObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackParametersObj>{nullptr}; }
 
  bool operator==(const MutableTrackParameters& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackParameters& other) const;
 
  bool operator!=(const MutableTrackParameters& other) const { return !(*this == other); }
  bool operator!=(const TrackParameters& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackParameters& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend std::hash<MutableTrackParameters>;
 
  friend void swap(MutableTrackParameters& a, MutableTrackParameters& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackParametersObj
  explicit MutableTrackParameters(podio::utils::MaybeSharedPtr<TrackParametersObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackParametersObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrackParameters& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableTrackParameters> {
  std::size_t operator()(const edm4eic::MutableTrackParameters& obj) const {
    return std::hash<edm4eic::TrackParametersObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif