MutablePMTHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutablePMTHit_H
#define EDM4EIC_MutablePMTHit_H
 
#include "edm4eic/PMTHitObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/PMTHit.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
 
 
 
namespace edm4eic {
 
 
/** @class MutablePMTHit
 *  EIC PMT hit
 *  @author: S. Joosten, C. Peng
 */
class MutablePMTHit {
 
  friend class PMTHitCollection;
  friend class PMTHitMutableCollectionIterator;
  friend class PMTHit;
 
public:
  using object_type = PMTHit;
  using collection_type = PMTHitCollection;
 
  /// default constructor
  MutablePMTHit();
 
  /// Constructor initializing all members
  MutablePMTHit(std::uint64_t cellID, float npe, float time, float timeError, edm4hep::Vector3f position, edm4hep::Vector3f dimension, std::int32_t sector, edm4hep::Vector3f local);
 
  /// copy constructor
  MutablePMTHit(const MutablePMTHit& other) = default;
 
  /// copy-assignment operator
  MutablePMTHit& operator=(MutablePMTHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutablePMTHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutablePMTHit() = default;
 
 
public:
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the Estimated number of photo-electrons [#]
  float getNpe() const;
 
  /// Access the Time [ns]
  float getTime() const;
 
  /// Access the Error on the time [ns]
  float getTimeError() const;
 
  /// Access the PMT hit position [mm]
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the The dimension information of the pixel [mm].
  const edm4hep::Vector3f& getDimension() const;
 
  /// Access the The sector this hit occurred in
  std::int32_t getSector() const;
 
  /// Access the The local position of the hit in detector coordinates (relative to the sector) [mm]
  const edm4hep::Vector3f& getLocal() 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 Estimated number of photo-electrons [#]
  void setNpe(float value);
  /// Get mutable reference to Estimated number of photo-electrons [#]
  float& getNpe();
  /// Get reference to Estimated number of photo-electrons [#]
  [[deprecated("use getNpe instead")]]
  float& npe();
 
  /// Set the Time [ns]
  void setTime(float value);
  /// Get mutable reference to Time [ns]
  float& getTime();
  /// Get reference to Time [ns]
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Error on the time [ns]
  void setTimeError(float value);
  /// Get mutable reference to Error on the time [ns]
  float& getTimeError();
  /// Get reference to Error on the time [ns]
  [[deprecated("use getTimeError instead")]]
  float& timeError();
 
  /// Set the PMT hit position [mm]
  void setPosition(edm4hep::Vector3f value);
  /// Get mutable reference to PMT hit position [mm]
  edm4hep::Vector3f& getPosition();
  /// Get reference to PMT hit position [mm]
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the The dimension information of the pixel [mm].
  void setDimension(edm4hep::Vector3f value);
  /// Get mutable reference to The dimension information of the pixel [mm].
  edm4hep::Vector3f& getDimension();
  /// Get reference to The dimension information of the pixel [mm].
  [[deprecated("use getDimension instead")]]
  edm4hep::Vector3f& dimension();
 
  /// Set the The sector this hit occurred in
  void setSector(std::int32_t value);
  /// Get mutable reference to The sector this hit occurred in
  std::int32_t& getSector();
  /// Get reference to The sector this hit occurred in
  [[deprecated("use getSector instead")]]
  std::int32_t& sector();
 
  /// Set the The local position of the hit in detector coordinates (relative to the sector) [mm]
  void setLocal(edm4hep::Vector3f value);
  /// Get mutable reference to The local position of the hit in detector coordinates (relative to the sector) [mm]
  edm4hep::Vector3f& getLocal();
  /// Get reference to The local position of the hit in detector coordinates (relative to the sector) [mm]
  [[deprecated("use getLocal instead")]]
  edm4hep::Vector3f& local();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from PMTHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<PMTHitObj>{nullptr}; }
 
  bool operator==(const MutablePMTHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const PMTHit& other) const;
 
  bool operator!=(const MutablePMTHit& other) const { return !(*this == other); }
  bool operator!=(const PMTHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutablePMTHit& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutablePMTHit& a, MutablePMTHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing PMTHitObj
  explicit MutablePMTHit(podio::utils::MaybeSharedPtr<PMTHitObj> obj);
 
  podio::utils::MaybeSharedPtr<PMTHitObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutablePMTHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif