ReconstructedParticleConst.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_ConstReconstructedParticle_H
#define EICD_ConstReconstructedParticle_H
 
#include "eicd/ReconstructedParticleObj.h"
 
#include "eicd/Direction.h"
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "eicd/Weight.h"
#include "podio/ObjectID.h"
 
 
 
namespace eic {
 
 
/** @class ConstReconstructedParticle
 *  EIC Reconstructed Particle
 *  @author: W. Armstrong, S. Joosten
 */
class ConstReconstructedParticle {
 
  friend class ReconstructedParticle;
  friend class ReconstructedParticleCollection;
  friend class ReconstructedParticleConstCollectionIterator;
 
public:
  /// default constructor
  ConstReconstructedParticle();
  ConstReconstructedParticle(eic::Index ID, eic::VectorXYZ p, eic::VectorXYZ v, float time, std::int32_t pid, std::int16_t status, std::int16_t charge, eic::Weight weight, eic::Direction direction, float momentum, float energy, float mass);
 
  /// constructor from existing ReconstructedParticleObj
  ConstReconstructedParticle(ReconstructedParticleObj* obj);
 
  /// copy constructor
  ConstReconstructedParticle(const ConstReconstructedParticle& other);
 
  /// copy-assignment operator
  ConstReconstructedParticle& operator=(const ConstReconstructedParticle& other);
 
  /// support cloning (deep-copy)
  ConstReconstructedParticle clone() const;
 
  /// destructor
  ~ConstReconstructedParticle();
 
 
public:
 
  /// Access the Unique particle index
  const eic::Index& ID() const;
 
  /// Access the momentum vector [GeV]
  const eic::VectorXYZ& p() const;
 
  /// Access the vertex [mm]
  const eic::VectorXYZ& v() const;
 
  /// Access the Time in [ns]
  const float& time() const;
 
  /// Access the PID of reconstructed particle.
  const std::int32_t& pid() const;
 
  /// Access the Status code
  const std::int16_t& status() const;
 
  /// Access the Particle charge (or sign)
  const std::int16_t& charge() const;
 
  /// Access the Particle weight, e.g. from PID algorithm [0-1]
  const eic::Weight& weight() const;
 
  /// Access the Direction (theta/phi of this particle [mrad])
  const eic::Direction& direction() const;
 
  /// Access the particle 3-momentum magnitude [GeV]
  const float& momentum() const;
 
  /// Access the Particle energy, consistent with PID assigment [GeV]
  const float& energy() const;
 
  /// Access the The mass of the particle in [GeV]
  const float& mass() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ReconstructedParticleObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const ConstReconstructedParticle& other) const { return m_obj == other.m_obj; }
  bool operator==(const ReconstructedParticle& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ConstReconstructedParticle& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  ReconstructedParticleObj* m_obj;
};
 
} // namespace eic
 
 
#endif