MutableJet.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableJet_H
#define EDM4EIC_MutableJet_H
 
#include "edm4eic/JetObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Jet.h"
 
#include "edm4eic/ReconstructedParticle.h"
#include "edm4hep/Vector3f.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 JetCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableJet
 *  A reconstructed jet, inspired by the FastJet PseudoJet
 *  @author: D. Anderson
 */
class MutableJet {
 
  friend class JetCollection;
  friend class JetMutableCollectionIterator;
  friend class Jet;
 
public:
  using object_type = Jet;
  using collection_type = JetCollection;
 
  /// default constructor
  MutableJet() = default;
 
  /// Constructor initializing all members
  MutableJet(const std::uint32_t type, const float area, const float energy, const float backgroundEnergyDensity, const edm4hep::Vector3f& momentum);
 
  /// copy constructor
  MutableJet(const MutableJet& other) = default;
 
  /// copy-assignment operator
  MutableJet& operator=(MutableJet other) &; // Rebind this to other's internal object
  MutableJet& operator=(MutableJet 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
  MutableJet clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableJet() = default;
 
 
public:
 
  /// Access the Jet type as enumerated in fastjet::JetAlgorithm
  std::uint32_t getType() const;
 
  /// Access the Jet area
  float getArea() const;
 
  /// Access the Jet energy [GeV]
  float getEnergy() const;
 
  /// Access the Background energy density [GeV/area]
  float getBackgroundEnergyDensity() const;
 
  /// Access the Jet 3-momentum [GeV]
  const edm4hep::Vector3f& getMomentum() const;
 
 
 
  /// Set the Jet type as enumerated in fastjet::JetAlgorithm
  void setType(const std::uint32_t type);
  /// Get mutable reference to Jet type as enumerated in fastjet::JetAlgorithm
  std::uint32_t& getType();
  /// Get reference to Jet type as enumerated in fastjet::JetAlgorithm
  [[deprecated("use getType instead")]]
  std::uint32_t& type();
 
  /// Set the Jet area
  void setArea(const float area);
  /// Get mutable reference to Jet area
  float& getArea();
  /// Get reference to Jet area
  [[deprecated("use getArea instead")]]
  float& area();
 
  /// Set the Jet energy [GeV]
  void setEnergy(const float energy);
  /// Get mutable reference to Jet energy [GeV]
  float& getEnergy();
  /// Get reference to Jet energy [GeV]
  [[deprecated("use getEnergy instead")]]
  float& energy();
 
  /// Set the Background energy density [GeV/area]
  void setBackgroundEnergyDensity(const float backgroundEnergyDensity);
  /// Get mutable reference to Background energy density [GeV/area]
  float& getBackgroundEnergyDensity();
  /// Get reference to Background energy density [GeV/area]
  [[deprecated("use getBackgroundEnergyDensity instead")]]
  float& backgroundEnergyDensity();
 
  /// Set the Jet 3-momentum [GeV]
  void setMomentum(const edm4hep::Vector3f& momentum);
  /// Get mutable reference to Jet 3-momentum [GeV]
  edm4hep::Vector3f& getMomentum();
  /// Get reference to Jet 3-momentum [GeV]
  [[deprecated("use getMomentum instead")]]
  edm4hep::Vector3f& momentum();
 
 
 
  void addToConstituents(const edm4eic::ReconstructedParticle&);
  std::size_t constituents_size() const;
  edm4eic::ReconstructedParticle getConstituents(std::size_t) const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator constituents_begin() const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator constituents_end() const;
  podio::RelationRange<edm4eic::ReconstructedParticle> getConstituents() const;
 
 /// Compute the background energy in [GeV]
 float getBackgroundEnergy() const { return getArea() * getBackgroundEnergyDensity(); }
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from JetObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<JetObj>{nullptr}; }
 
  bool operator==(const MutableJet& other) const { return m_obj == other.m_obj; }
  bool operator==(const Jet& other) const;
 
  bool operator!=(const MutableJet& other) const { return !(*this == other); }
  bool operator!=(const Jet& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableJet& 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<MutableJet>;
 
  friend void swap(MutableJet& a, MutableJet& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing JetObj
  explicit MutableJet(podio::utils::MaybeSharedPtr<JetObj> obj);
 
  podio::utils::MaybeSharedPtr<JetObj> m_obj{new JetObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableJet& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableJet> {
  std::size_t operator()(const edm4eic::MutableJet& obj) const {
    return std::hash<edm4eic::JetObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif