MutableTrackerHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrackerHit_H
#define EDM4EIC_MutableTrackerHit_H
 
#include "edm4eic/TrackerHitObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/TrackerHit.h"
 
#include "edm4eic/CovDiag3f.h"
#include "edm4hep/Vector3f.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 TrackerHitCollection;
class RawTrackerHit;
class MutableRawTrackerHit;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrackerHit
 *  Tracker hit (reconstructed from Raw)
 *  @author: W. Armstrong, S. Joosten
 */
class MutableTrackerHit {
 
  friend class TrackerHitCollection;
  friend class TrackerHitMutableCollectionIterator;
  friend class TrackerHit;
 
public:
  using object_type = TrackerHit;
  using collection_type = TrackerHitCollection;
 
  /// default constructor
  MutableTrackerHit();
 
  /// Constructor initializing all members
  MutableTrackerHit(std::uint64_t cellID, edm4hep::Vector3f position, edm4eic::CovDiag3f positionError, float time, float timeError, float edep, float edepError);
 
  /// copy constructor
  MutableTrackerHit(const MutableTrackerHit& other) = default;
 
  /// copy-assignment operator
  MutableTrackerHit& operator=(MutableTrackerHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackerHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrackerHit() = default;
 
 
public:
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the Hit (cell) position [mm]
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Covariance Matrix
  const edm4eic::CovDiag3f& getPositionError() const;
 
  /// Access the Hit time [ns]
  float getTime() const;
 
  /// Access the Error on the time
  float getTimeError() const;
 
  /// Access the Energy deposit in this hit [GeV]
  float getEdep() const;
 
  /// Access the Error on the energy deposit [GeV]
  float getEdepError() const;
 
 
  /// Access the Related raw tracker hit
  const edm4eic::RawTrackerHit getRawHit() const;
 
  /// Set the The detector specific (geometrical) cell id.
  void setCellID(std::uint64_t value);
  /// Get mutable reference to The detector specific (geometrical) cell id.
  std::uint64_t& getCellID();
  /// Get reference to The detector specific (geometrical) cell id.
  [[deprecated("use getCellID instead")]]
  std::uint64_t& cellID();
 
  /// Set the Hit (cell) position [mm]
  void setPosition(edm4hep::Vector3f value);
  /// Get mutable reference to Hit (cell) position [mm]
  edm4hep::Vector3f& getPosition();
  /// Get reference to Hit (cell) position [mm]
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the Covariance Matrix
  void setPositionError(edm4eic::CovDiag3f value);
  /// Get mutable reference to Covariance Matrix
  edm4eic::CovDiag3f& getPositionError();
  /// Get reference to Covariance Matrix
  [[deprecated("use getPositionError instead")]]
  edm4eic::CovDiag3f& positionError();
 
  /// Set the Hit time [ns]
  void setTime(float value);
  /// Get mutable reference to Hit time [ns]
  float& getTime();
  /// Get reference to Hit time [ns]
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Error on the time
  void setTimeError(float value);
  /// Get mutable reference to Error on the time
  float& getTimeError();
  /// Get reference to Error on the time
  [[deprecated("use getTimeError instead")]]
  float& timeError();
 
  /// Set the Energy deposit in this hit [GeV]
  void setEdep(float value);
  /// Get mutable reference to Energy deposit in this hit [GeV]
  float& getEdep();
  /// Get reference to Energy deposit in this hit [GeV]
  [[deprecated("use getEdep instead")]]
  float& edep();
 
  /// Set the Error on the energy deposit [GeV]
  void setEdepError(float value);
  /// Get mutable reference to Error on the energy deposit [GeV]
  float& getEdepError();
  /// Get reference to Error on the energy deposit [GeV]
  [[deprecated("use getEdepError instead")]]
  float& edepError();
 
 
  /// Set the Related raw tracker hit
  void setRawHit(const edm4eic::RawTrackerHit& value);
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackerHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackerHitObj>{nullptr}; }
 
  bool operator==(const MutableTrackerHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackerHit& other) const;
 
  bool operator!=(const MutableTrackerHit& other) const { return !(*this == other); }
  bool operator!=(const TrackerHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackerHit& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableTrackerHit& a, MutableTrackerHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackerHitObj
  explicit MutableTrackerHit(podio::utils::MaybeSharedPtr<TrackerHitObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackerHitObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrackerHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif