MutableMCRecoCalorimeterHitAssociation.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableMCRecoCalorimeterHitAssociation_H
#define EDM4EIC_MutableMCRecoCalorimeterHitAssociation_H
 
#include "edm4eic/MCRecoCalorimeterHitAssociationObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/MCRecoCalorimeterHitAssociation.h"
 
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4hep {
class RawCalorimeterHit;
class MutableRawCalorimeterHit;
class SimCalorimeterHit;
class MutableSimCalorimeterHit;
}
 
 
namespace edm4eic {
 
 
/** @class MutableMCRecoCalorimeterHitAssociation
 *  Association between a RawCalorimeterHit and a SimCalorimeterHit
 *  @author: S. Rahman
 */
class MutableMCRecoCalorimeterHitAssociation {
 
  friend class MCRecoCalorimeterHitAssociationCollection;
  friend class MCRecoCalorimeterHitAssociationMutableCollectionIterator;
  friend class MCRecoCalorimeterHitAssociation;
 
public:
  using object_type = MCRecoCalorimeterHitAssociation;
  using collection_type = MCRecoCalorimeterHitAssociationCollection;
 
  /// default constructor
  MutableMCRecoCalorimeterHitAssociation();
 
  /// Constructor initializing all members
  MutableMCRecoCalorimeterHitAssociation(float weight);
 
  /// copy constructor
  MutableMCRecoCalorimeterHitAssociation(const MutableMCRecoCalorimeterHitAssociation& other) = default;
 
  /// copy-assignment operator
  MutableMCRecoCalorimeterHitAssociation& operator=(MutableMCRecoCalorimeterHitAssociation 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
  ~MutableMCRecoCalorimeterHitAssociation() = default;
 
 
public:
 
  /// 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;
 
  /// Set the weight of this association
  void setWeight(float value);
  /// Get mutable reference to weight of this association
  float& getWeight();
  /// Get reference to weight of this association
  [[deprecated("use getWeight instead")]]
  float& weight();
 
 
  /// Set the reference to the digitized calorimeter hit
  void setRawHit(const edm4hep::RawCalorimeterHit& value);
  /// Set the reference to the simulated calorimeter hit
  void setSimHit(const edm4hep::SimCalorimeterHit& value);
 
 
 
 
  /// 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 MutableMCRecoCalorimeterHitAssociation& other) const { return m_obj == other.m_obj; }
  bool operator==(const MCRecoCalorimeterHitAssociation& other) const;
 
  bool operator!=(const MutableMCRecoCalorimeterHitAssociation& other) const { return !(*this == other); }
  bool operator!=(const MCRecoCalorimeterHitAssociation& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableMCRecoCalorimeterHitAssociation& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableMCRecoCalorimeterHitAssociation& a, MutableMCRecoCalorimeterHitAssociation& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing MCRecoCalorimeterHitAssociationObj
  explicit MutableMCRecoCalorimeterHitAssociation(podio::utils::MaybeSharedPtr<MCRecoCalorimeterHitAssociationObj> obj);
 
  podio::utils::MaybeSharedPtr<MCRecoCalorimeterHitAssociationObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableMCRecoCalorimeterHitAssociation& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif