MCRecoCalorimeterHitAssociation.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MCRecoCalorimeterHitAssociation_H
#define EDM4EIC_MCRecoCalorimeterHitAssociation_H
 
#include "edm4eic/MCRecoCalorimeterHitAssociationObj.h"
 
 
#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 MCRecoCalorimeterHitAssociationCollection;
}
namespace edm4hep {
class RawCalorimeterHit;
class MutableRawCalorimeterHit;
class SimCalorimeterHit;
class MutableSimCalorimeterHit;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::MCRecoCalorimeterHitAssociation& obj);
};
 
namespace edm4eic {
 
class MutableMCRecoCalorimeterHitAssociation;
class MCRecoCalorimeterHitAssociationCollection;
class MCRecoCalorimeterHitAssociationCollectionData;
 
/** @class MCRecoCalorimeterHitAssociation
 *  Association between a RawCalorimeterHit and a SimCalorimeterHit
 *  @author: S. Rahman
 */
class MCRecoCalorimeterHitAssociation {
 
  friend class MutableMCRecoCalorimeterHitAssociation;
  friend class MCRecoCalorimeterHitAssociationCollection;
  friend class edm4eic::MCRecoCalorimeterHitAssociationCollectionData;
  friend class MCRecoCalorimeterHitAssociationCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const MCRecoCalorimeterHitAssociation & obj);
 
public:
  using mutable_type = MutableMCRecoCalorimeterHitAssociation;
  using collection_type = MCRecoCalorimeterHitAssociationCollection;
 
  /// default constructor
  MCRecoCalorimeterHitAssociation();
 
  /// Constructor initializing all members
  MCRecoCalorimeterHitAssociation(float weight);
 
  /// copy constructor
  MCRecoCalorimeterHitAssociation(const MCRecoCalorimeterHitAssociation& other) = default;
 
  /// copy-assignment operator
  MCRecoCalorimeterHitAssociation& operator=(MCRecoCalorimeterHitAssociation other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableMCRecoCalorimeterHitAssociation clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MCRecoCalorimeterHitAssociation() = default;
 
  /// converting constructor from mutable object
  MCRecoCalorimeterHitAssociation(const MutableMCRecoCalorimeterHitAssociation& other);
 
  static MCRecoCalorimeterHitAssociation makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::MCRecoCalorimeterHitAssociation";
 
  /// Access the weight of this association
  float getWeight() const;
 
 
  /// Access the reference to the digitized calorimeter hit
  const edm4hep::RawCalorimeterHit getRawHit() const;
  /// Access the reference to the simulated calorimeter hit
  const edm4hep::SimCalorimeterHit getSimHit() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from MCRecoCalorimeterHitAssociationObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<MCRecoCalorimeterHitAssociationObj>{nullptr}; }
 
  bool operator==(const MCRecoCalorimeterHitAssociation& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableMCRecoCalorimeterHitAssociation& other) const;
 
  bool operator!=(const MCRecoCalorimeterHitAssociation& other) const { return !(*this == other); }
  bool operator!=(const MutableMCRecoCalorimeterHitAssociation& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MCRecoCalorimeterHitAssociation& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MCRecoCalorimeterHitAssociation& a, MCRecoCalorimeterHitAssociation& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing MCRecoCalorimeterHitAssociationObj
  explicit MCRecoCalorimeterHitAssociation(podio::utils::MaybeSharedPtr<MCRecoCalorimeterHitAssociationObj> obj);
  MCRecoCalorimeterHitAssociation(MCRecoCalorimeterHitAssociationObj* obj);
 
  podio::utils::MaybeSharedPtr<MCRecoCalorimeterHitAssociationObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const MCRecoCalorimeterHitAssociation& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MCRecoCalorimeterHitAssociation& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif