MCRecoClusterParticleAssociation.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MCRecoClusterParticleAssociation_H
#define EICD_MCRecoClusterParticleAssociation_H
 
#include "eicd/MCRecoClusterParticleAssociationObj.h"
 
#include <cstdint>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
// forward declarations
namespace eicd {
class Cluster;
class MutableCluster;
}
namespace edm4hep {
class MCParticle;
class MutableMCParticle;
}
 
 
namespace eicd {
 
class MutableMCRecoClusterParticleAssociation;
 
/** @class MCRecoClusterParticleAssociation
 *  Association between a Cluster and a MCParticle
 *  @author: S. Joosten
 */
class MCRecoClusterParticleAssociation {
 
  friend class MutableMCRecoClusterParticleAssociation;
  friend class MCRecoClusterParticleAssociationCollection;
  friend class MCRecoClusterParticleAssociationCollectionIterator;
 
public:
  /// default constructor
  MCRecoClusterParticleAssociation();
  MCRecoClusterParticleAssociation(std::uint32_t simID, std::uint32_t recID, float weight);
 
  /// constructor from existing MCRecoClusterParticleAssociationObj
  MCRecoClusterParticleAssociation(MCRecoClusterParticleAssociationObj* obj);
 
  /// copy constructor
  MCRecoClusterParticleAssociation(const MCRecoClusterParticleAssociation& other);
 
  /// copy-assignment operator
  MCRecoClusterParticleAssociation& operator=(MCRecoClusterParticleAssociation other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableMCRecoClusterParticleAssociation clone() const;
 
  /// destructor
  ~MCRecoClusterParticleAssociation();
 
 
public:
 
  /// Access the Index of corresponding MCParticle (position in MCParticles array)
  const std::uint32_t& getSimID() const;
 
  /// Access the Index of corresponding Cluster (position in Clusters array)
  const std::uint32_t& getRecID() const;
 
  /// Access the weight of this association
  const float& getWeight() const;
 
 
  /// Access the reference to the cluster
  const eicd::Cluster getRec() const;
  /// Access the reference to the Monte-Carlo particle
  const edm4hep::MCParticle getSim() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from MCRecoClusterParticleAssociationObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MCRecoClusterParticleAssociation& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableMCRecoClusterParticleAssociation& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MCRecoClusterParticleAssociation& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MCRecoClusterParticleAssociation& a, MCRecoClusterParticleAssociation& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  MCRecoClusterParticleAssociationObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const MCRecoClusterParticleAssociation& value);
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MCRecoClusterParticleAssociation& value);
#endif
 
 
} // namespace eicd
 
 
#endif