MutableIrtParticle.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableIrtParticle_H
#define EDM4EIC_MutableIrtParticle_H
 
#include "edm4eic/IrtParticleObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/IrtParticle.h"
 
#include "edm4eic/IrtRadiatorInfo.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 IrtParticleCollection;
class Track;
class MutableTrack;
}
 
 
namespace edm4eic {
 
 
/** @class MutableIrtParticle
 *  IRT 2.1 output (track level)
 *  @author: A. Kiselev
 */
class MutableIrtParticle {
 
  friend class IrtParticleCollection;
  friend class IrtParticleMutableCollectionIterator;
  friend class IrtParticle;
 
public:
  using object_type = IrtParticle;
  using collection_type = IrtParticleCollection;
 
  /// default constructor
  MutableIrtParticle() = default;
 
  /// Constructor initializing all members
  MutableIrtParticle(const std::int32_t PDG, const std::uint16_t npe, const std::uint16_t nhits);
 
  /// copy constructor
  MutableIrtParticle(const MutableIrtParticle& other) = default;
 
  /// copy-assignment operator
  MutableIrtParticle& operator=(MutableIrtParticle other) &; // Rebind this to other's internal object
  MutableIrtParticle& operator=(MutableIrtParticle 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
  ~MutableIrtParticle() = default;
 
 
public:
 
  /// 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;
 
  /// Set the Reconstructed most probable PDG code
  void setPDG(const std::int32_t PDG);
  /// Get mutable reference to Reconstructed most probable PDG code
  std::int32_t& getPDG();
  /// Get reference to Reconstructed most probable PDG code
  [[deprecated("use getPDG instead")]]
  std::int32_t& PDG();
 
  /// Set the Detected photoelectron count
  void setNpe(const std::uint16_t npe);
  /// Get mutable reference to Detected photoelectron count
  std::uint16_t& getNpe();
  /// Get reference to Detected photoelectron count
  [[deprecated("use getNpe instead")]]
  std::uint16_t& npe();
 
  /// Set the Hit count associated with this particle by IRT engine
  void setNhits(const std::uint16_t nhits);
  /// Get mutable reference to Hit count associated with this particle by IRT engine
  std::uint16_t& getNhits();
  /// Get reference to Hit count associated with this particle by IRT engine
  [[deprecated("use getNhits instead")]]
  std::uint16_t& nhits();
 
 
  /// Set the charged particle track
  void setTrack(const edm4eic::Track& value);
 
  void addToRadiators(const edm4eic::IrtRadiatorInfo&);
  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 MutableIrtParticle& other) const { return m_obj == other.m_obj; }
  bool operator==(const IrtParticle& other) const;
 
  bool operator!=(const MutableIrtParticle& other) const { return !(*this == other); }
  bool operator!=(const IrtParticle& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableIrtParticle& 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<MutableIrtParticle>;
 
  friend void swap(MutableIrtParticle& a, MutableIrtParticle& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing IrtParticleObj
  explicit MutableIrtParticle(podio::utils::MaybeSharedPtr<IrtParticleObj> obj);
 
  podio::utils::MaybeSharedPtr<IrtParticleObj> m_obj{new IrtParticleObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableIrtParticle& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableIrtParticle> {
  std::size_t operator()(const edm4eic::MutableIrtParticle& obj) const {
    return std::hash<edm4eic::IrtParticleObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif