MCRecoTrackerHitAssociation.h

Go to the documentation of this file.

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