MutableRawTrackerHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableRawTrackerHit_H
#define EDM4EIC_MutableRawTrackerHit_H
 
#include "edm4eic/RawTrackerHitObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/RawTrackerHit.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 RawTrackerHitCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableRawTrackerHit
 *  Raw (digitized) tracker hit
 *  @author: W. Armstrong, S. Joosten
 */
class MutableRawTrackerHit {
 
  friend class RawTrackerHitCollection;
  friend class RawTrackerHitMutableCollectionIterator;
  friend class RawTrackerHit;
 
public:
  using object_type = RawTrackerHit;
  using collection_type = RawTrackerHitCollection;
 
  /// default constructor
  MutableRawTrackerHit();
 
  /// Constructor initializing all members
  MutableRawTrackerHit(std::uint64_t cellID, std::int32_t charge, std::int32_t timeStamp);
 
  /// copy constructor
  MutableRawTrackerHit(const MutableRawTrackerHit& other) = default;
 
  /// copy-assignment operator
  MutableRawTrackerHit& operator=(MutableRawTrackerHit other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableRawTrackerHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableRawTrackerHit() = default;
 
 
public:
 
  /// Access the The detector specific (geometrical) cell id.
  std::uint64_t getCellID() const;
 
  /// Access the ADC value
  std::int32_t getCharge() const;
 
  /// Access the TDC value.
  std::int32_t getTimeStamp() 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 ADC value
  void setCharge(std::int32_t value);
  /// Get mutable reference to ADC value
  std::int32_t& getCharge();
  /// Get reference to ADC value
  [[deprecated("use getCharge instead")]]
  std::int32_t& charge();
 
  /// Set the TDC value.
  void setTimeStamp(std::int32_t value);
  /// Get mutable reference to TDC value.
  std::int32_t& getTimeStamp();
  /// Get reference to TDC value.
  [[deprecated("use getTimeStamp instead")]]
  std::int32_t& timeStamp();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawTrackerHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawTrackerHitObj>{nullptr}; }
 
  bool operator==(const MutableRawTrackerHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const RawTrackerHit& other) const;
 
  bool operator!=(const MutableRawTrackerHit& other) const { return !(*this == other); }
  bool operator!=(const RawTrackerHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableRawTrackerHit& 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(MutableRawTrackerHit& a, MutableRawTrackerHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RawTrackerHitObj
  explicit MutableRawTrackerHit(podio::utils::MaybeSharedPtr<RawTrackerHitObj> obj);
 
  podio::utils::MaybeSharedPtr<RawTrackerHitObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableRawTrackerHit& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif