MutableRawCALOROCHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableRawCALOROCHit_H
#define EDM4EIC_MutableRawCALOROCHit_H
 
#include "edm4eic/RawCALOROCHitObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/RawCALOROCHit.h"
 
#include "edm4eic/CALOROC1ASample.h"
#include "edm4eic/CALOROC1BSample.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 RawCALOROCHitCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableRawCALOROCHit
 *  Raw hit from a CALOROC1A/B chip
 *  @author: D. Anderson, S. Joosten, T. Protzman, N. Novitzky, D. Kalinkin, M. Zurek, M. H. Kim
 */
class MutableRawCALOROCHit {
 
  friend class RawCALOROCHitCollection;
  friend class RawCALOROCHitMutableCollectionIterator;
  friend class RawCALOROCHit;
 
public:
  using object_type = RawCALOROCHit;
  using collection_type = RawCALOROCHitCollection;
 
  /// default constructor
  MutableRawCALOROCHit() = default;
 
  /// Constructor initializing all members
  MutableRawCALOROCHit(const std::uint64_t cellID, const std::int32_t samplePhase, const std::int32_t timeStamp);
 
  /// copy constructor
  MutableRawCALOROCHit(const MutableRawCALOROCHit& other) = default;
 
  /// copy-assignment operator
  MutableRawCALOROCHit& operator=(MutableRawCALOROCHit other) &; // Rebind this to other's internal object
  MutableRawCALOROCHit& operator=(MutableRawCALOROCHit 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
  MutableRawCALOROCHit clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableRawCALOROCHit() = 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 addToASamples(const edm4eic::CALOROC1ASample&);
  std::size_t aSamples_size() const;
  edm4eic::CALOROC1ASample getASamples(std::size_t) const;
  std::vector<edm4eic::CALOROC1ASample>::const_iterator aSamples_begin() const;
  std::vector<edm4eic::CALOROC1ASample>::const_iterator aSamples_end() const;
  podio::RelationRange<edm4eic::CALOROC1ASample> getASamples() const;
  void addToBSamples(const edm4eic::CALOROC1BSample&);
  std::size_t bSamples_size() const;
  edm4eic::CALOROC1BSample getBSamples(std::size_t) const;
  std::vector<edm4eic::CALOROC1BSample>::const_iterator bSamples_begin() const;
  std::vector<edm4eic::CALOROC1BSample>::const_iterator bSamples_end() const;
  podio::RelationRange<edm4eic::CALOROC1BSample> getBSamples() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawCALOROCHitObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<RawCALOROCHitObj>{nullptr}; }
 
  bool operator==(const MutableRawCALOROCHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const RawCALOROCHit& other) const;
 
  bool operator!=(const MutableRawCALOROCHit& other) const { return !(*this == other); }
  bool operator!=(const RawCALOROCHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableRawCALOROCHit& 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<MutableRawCALOROCHit>;
 
  friend void swap(MutableRawCALOROCHit& a, MutableRawCALOROCHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RawCALOROCHitObj
  explicit MutableRawCALOROCHit(podio::utils::MaybeSharedPtr<RawCALOROCHitObj> obj);
 
  podio::utils::MaybeSharedPtr<RawCALOROCHitObj> m_obj{new RawCALOROCHitObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableRawCALOROCHit& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableRawCALOROCHit> {
  std::size_t operator()(const edm4eic::MutableRawCALOROCHit& obj) const {
    return std::hash<edm4eic::RawCALOROCHitObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif