MutableTrackerHit.h

Go to the documentation of this file.

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