RawCALOROCHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_RawCALOROCHit_H
#define EDM4EIC_RawCALOROCHit_H
 
#include "edm4eic/RawCALOROCHitObj.h"
 
#include "edm4eic/CALOROC1ASample.h"
#include "edm4eic/CALOROC1BSample.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
#include "podio/detail/OrderKey.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class RawCALOROCHitCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::RawCALOROCHit& obj);
};
 
namespace edm4eic {
 
class MutableRawCALOROCHit;
class RawCALOROCHitCollection;
class RawCALOROCHitCollectionData;
 
/** @class RawCALOROCHit
 *  Raw hit from a CALOROC1A/B chip
 *  @author: D. Anderson, S. Joosten, T. Protzman, N. Novitzky, D. Kalinkin, M. Zurek, M. H. Kim
 */
class RawCALOROCHit {
 
  friend class MutableRawCALOROCHit;
  friend class RawCALOROCHitCollection;
  friend class edm4eic::RawCALOROCHitCollectionData;
  friend class RawCALOROCHitCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const RawCALOROCHit & obj);
 
public:
  using mutable_type = MutableRawCALOROCHit;
  using collection_type = RawCALOROCHitCollection;
 
  /// default constructor
  RawCALOROCHit() = default;
 
  /// Constructor initializing all members
  RawCALOROCHit(const std::uint64_t cellID, const std::int32_t samplePhase, const std::int32_t timeStamp);
 
  /// copy constructor
  RawCALOROCHit(const RawCALOROCHit& other) = default;
 
  /// copy-assignment operator
  RawCALOROCHit& operator=(RawCALOROCHit other) &; // Rebind this to other's internal object
  RawCALOROCHit& operator=(RawCALOROCHit 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
  ~RawCALOROCHit() = default;
 
  /// converting constructor from mutable object
  RawCALOROCHit(const MutableRawCALOROCHit& other);
 
  static RawCALOROCHit makeEmpty();
 
public:
 
  static constexpr std::string_view typeName = "edm4eic::RawCALOROCHit";
 
  /// 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;
 
 
 
  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;
  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 RawCALOROCHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableRawCALOROCHit& other) const;
 
  bool operator!=(const RawCALOROCHit& other) const { return !(*this == other); }
  bool operator!=(const MutableRawCALOROCHit& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawCALOROCHit& 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<RawCALOROCHit>;
 
  friend void swap(RawCALOROCHit& a, RawCALOROCHit& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RawCALOROCHitObj
  explicit RawCALOROCHit(podio::utils::MaybeSharedPtr<RawCALOROCHitObj> obj);
  RawCALOROCHit(RawCALOROCHitObj* obj);
 
  podio::utils::MaybeSharedPtr<RawCALOROCHitObj> m_obj{new RawCALOROCHitObj{}, podio::utils::MarkOwned};
};
 
std::ostream& operator<<(std::ostream& o, const RawCALOROCHit& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const RawCALOROCHit& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::RawCALOROCHit> {
  std::size_t operator()(const edm4eic::RawCALOROCHit& obj) const {
    return std::hash<edm4eic::RawCALOROCHitObj*>{}(obj.m_obj.get());
  }
};
 
 
// This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
// until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
// and https://github.com/AIDASoft/podio/issues/770
#if defined(__clang__)
  #pragma clang diagnostic push
  #pragma clang diagnostic ignored "-Wunknown-warning-option"
  #pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
  #pragma clang diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::RawCALOROCHit::typeName;
  #pragma clang diagnostic pop
#elif defined(__GNUC__)
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::RawCALOROCHit::typeName;
  #pragma GCC diagnostic pop
#endif
 
 
#endif