IrtParticle.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_IrtParticle_H
#define EDM4EIC_IrtParticle_H
 
#include "edm4eic/IrtParticleObj.h"
 
#include "edm4eic/IrtRadiatorInfo.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 IrtParticleCollection;
class Track;
class MutableTrack;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::IrtParticle& obj);
};
 
namespace edm4eic {
 
class MutableIrtParticle;
class IrtParticleCollection;
class IrtParticleCollectionData;
 
/** @class IrtParticle
 *  IRT 2.1 output (track level)
 *  @author: A. Kiselev
 */
class IrtParticle {
 
  friend class MutableIrtParticle;
  friend class IrtParticleCollection;
  friend class edm4eic::IrtParticleCollectionData;
  friend class IrtParticleCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const IrtParticle & obj);
 
public:
  using mutable_type = MutableIrtParticle;
  using collection_type = IrtParticleCollection;
 
  /// default constructor
  IrtParticle() = default;
 
  /// Constructor initializing all members
  IrtParticle(const std::int32_t PDG, const std::uint16_t npe, const std::uint16_t nhits);
 
  /// copy constructor
  IrtParticle(const IrtParticle& other) = default;
 
  /// copy-assignment operator
  IrtParticle& operator=(IrtParticle other) &; // Rebind this to other's internal object
  IrtParticle& operator=(IrtParticle 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
  MutableIrtParticle clone(bool cloneRelations=true) const;
 
  /// destructor
  ~IrtParticle() = default;
 
  /// converting constructor from mutable object
  IrtParticle(const MutableIrtParticle& other);
 
  static IrtParticle makeEmpty();
 
public:
 
  static constexpr std::string_view typeName = "edm4eic::IrtParticle";
 
  /// Access the Reconstructed most probable PDG code
  std::int32_t getPDG() const;
 
  /// Access the Detected photoelectron count
  std::uint16_t getNpe() const;
 
  /// Access the Hit count associated with this particle by IRT engine
  std::uint16_t getNhits() const;
 
 
  /// Access the charged particle track
  const edm4eic::Track getTrack() const;
 
  std::size_t radiators_size() const;
  edm4eic::IrtRadiatorInfo getRadiators(std::size_t) const;
  std::vector<edm4eic::IrtRadiatorInfo>::const_iterator radiators_begin() const;
  std::vector<edm4eic::IrtRadiatorInfo>::const_iterator radiators_end() const;
  podio::RelationRange<edm4eic::IrtRadiatorInfo> getRadiators() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from IrtParticleObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<IrtParticleObj>{nullptr}; }
 
  bool operator==(const IrtParticle& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableIrtParticle& other) const;
 
  bool operator!=(const IrtParticle& other) const { return !(*this == other); }
  bool operator!=(const MutableIrtParticle& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const IrtParticle& 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<IrtParticle>;
 
  friend void swap(IrtParticle& a, IrtParticle& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing IrtParticleObj
  explicit IrtParticle(podio::utils::MaybeSharedPtr<IrtParticleObj> obj);
  IrtParticle(IrtParticleObj* obj);
 
  podio::utils::MaybeSharedPtr<IrtParticleObj> m_obj{new IrtParticleObj{}, podio::utils::MarkOwned};
};
 
std::ostream& operator<<(std::ostream& o, const IrtParticle& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const IrtParticle& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::IrtParticle> {
  std::size_t operator()(const edm4eic::IrtParticle& obj) const {
    return std::hash<edm4eic::IrtParticleObj*>{}(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::IrtParticle::typeName;
  #pragma clang diagnostic pop
#elif defined(__GNUC__)
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::IrtParticle::typeName;
  #pragma GCC diagnostic pop
#endif
 
 
#endif