MutableRawHGCROCHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableRawHGCROCHit_H
#define EDM4EIC_MutableRawHGCROCHit_H
 
#include "edm4eic/RawHGCROCHitObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/RawHGCROCHit.h"
 
#include "edm4eic/HGCROCSample.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#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 RawHGCROCHitCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableRawHGCROCHit
 *  Raw hit from an HGCROC chip
 *  @author: D. Anderson, S. Joosten, T. Protzman, N. Novitzky, D. Kalinkin
 */
class MutableRawHGCROCHit {
 
  friend class RawHGCROCHitCollection;
  friend class RawHGCROCHitMutableCollectionIterator;
  friend class RawHGCROCHit;
 
public:
  using object_type = RawHGCROCHit;
  using collection_type = RawHGCROCHitCollection;
 
  /// default constructor
  MutableRawHGCROCHit();
 
  /// Constructor initializing all members
  MutableRawHGCROCHit(const std::uint64_t cellID, const std::int32_t samplePhase, const std::int32_t timeStamp);
 
  /// copy constructor
  MutableRawHGCROCHit(const MutableRawHGCROCHit& other) = default;
 
  /// copy-assignment operator
  MutableRawHGCROCHit& operator=(MutableRawHGCROCHit other) &; // Rebind this to other's internal object
  MutableRawHGCROCHit& operator=(MutableRawHGCROCHit 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
  MutableRawHGCROCHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableRawHGCROCHit() = default;
 
 
public:
 
  /// Access the Detector specific (geometrical) cell id
  std::uint64_t getCellID() const;
 
  /// Access the Phase of samples in [# samples], for synchronizing across chips
  std::int32_t getSamplePhase() const;
 
  /// Access the [TDC counts]
  std::int32_t getTimeStamp() const;
 
 
 
  /// Set the Detector specific (geometrical) cell id
  void setCellID(const std::uint64_t cellID);
  /// Get mutable reference to Detector specific (geometrical) cell id
  std::uint64_t& getCellID();
  /// Get reference to Detector specific (geometrical) cell id
  [[deprecated("use getCellID instead")]]
  std::uint64_t& cellID();
 
  /// Set the Phase of samples in [# samples], for synchronizing across chips
  void setSamplePhase(const std::int32_t samplePhase);
  /// Get mutable reference to Phase of samples in [# samples], for synchronizing across chips
  std::int32_t& getSamplePhase();
  /// Get reference to Phase of samples in [# samples], for synchronizing across chips
  [[deprecated("use getSamplePhase instead")]]
  std::int32_t& samplePhase();
 
  /// Set the [TDC counts]
  void setTimeStamp(const std::int32_t timeStamp);
  /// Get mutable reference to [TDC counts]
  std::int32_t& getTimeStamp();
  /// Get reference to [TDC counts]
  [[deprecated("use getTimeStamp instead")]]
  std::int32_t& timeStamp();
 
 
 
  void addToSamples(const edm4eic::HGCROCSample&);
  std::size_t samples_size() const;
  edm4eic::HGCROCSample getSamples(std::size_t) const;
  std::vector<edm4eic::HGCROCSample>::const_iterator samples_begin() const;
  std::vector<edm4eic::HGCROCSample>::const_iterator samples_end() const;
  podio::RelationRange<edm4eic::HGCROCSample> getSamples() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawHGCROCHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawHGCROCHitObj>{nullptr}; }
 
  bool operator==(const MutableRawHGCROCHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const RawHGCROCHit& other) const;
 
  bool operator!=(const MutableRawHGCROCHit& other) const { return !(*this == other); }
  bool operator!=(const RawHGCROCHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableRawHGCROCHit& 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<MutableRawHGCROCHit>;
 
  friend void swap(MutableRawHGCROCHit& a, MutableRawHGCROCHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RawHGCROCHitObj
  explicit MutableRawHGCROCHit(podio::utils::MaybeSharedPtr<RawHGCROCHitObj> obj);
 
  podio::utils::MaybeSharedPtr<RawHGCROCHitObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableRawHGCROCHit& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableRawHGCROCHit> {
  std::size_t operator()(const edm4eic::MutableRawHGCROCHit& obj) const {
    return std::hash<edm4eic::RawHGCROCHitObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif