ISFParticle.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_EVENT_ISFPARTICLE_H
#define ISF_EVENT_ISFPARTICLE_H
 
// Gaudi Kernel
#include "GaudiKernel/MsgStream.h"
// Barcode includes
#include "TruthUtils/MagicNumbers.h"
// ISF include
#include "ISF_Event/TruthBinding.h"
#include "ISF_Event/SimSvcID.h"
#include "ISF_Event/ParticleOrder.h"
#include "ISF_Event/ParticleUserInformation.h"
// DetectorDescription
#include "AtlasDetDescr/AtlasRegion.h"
// Amg classes
#include "GeoPrimitives/GeoPrimitives.h"
// CHLEP classes
#include "CLHEP/Geometry/Point3D.h"
#include "CLHEP/Geometry/Vector3D.h"
// Common classes
#include "GeneratorObjects/HepMcParticleLink.h"
 
namespace ISF {

  typedef std::pair< AtlasDetDescr::AtlasRegion, ISF::SimSvcID >   DetRegionSvcIDPair;
  typedef std::vector< DetRegionSvcIDPair >                        ParticleHistory;

 
  class ISFParticle {
 
  public:
    ISFParticle() = delete;

    ISFParticle(const Amg::Vector3D& pos,
                const Amg::Vector3D& mom,
                double mass,
                double charge,
                int pdgCode,
                int status,
                double time,
                const ISFParticle &parent,
                int id,
                int barcode = HepMC::UNDEFINED_ID,
                TruthBinding* truth = nullptr,
                const HepMcParticleLink * partLink = nullptr );

    ISFParticle(const HepGeom::Point3D<double>& pos,
                const HepGeom::Vector3D<double>& mom,
                double mass,
                double charge,
                int pdgCode,
                int status,
                double time,
                const ISFParticle &parent,
                int id,
                int barcode = HepMC::UNDEFINED_ID,
                TruthBinding* truth = nullptr,
                const HepMcParticleLink * partLink = nullptr );

    ISFParticle(const Amg::Vector3D& pos,
                const Amg::Vector3D& mom,
                double mass,
                double charge,
                int pdgCode,
                int status,
                double time,
                const DetRegionSvcIDPair &origin,
                int id,
                int barcode = HepMC::UNDEFINED_ID,
                TruthBinding* truth = nullptr,
                const HepMcParticleLink * partLink = nullptr );

    ISFParticle(const ISFParticle& isfp);

    ISFParticle(ISFParticle&& isfp);

    ~ISFParticle();

    ISFParticle& operator=(const ISFParticle& rhs);

    ISFParticle& operator=(ISFParticle&& rhs);

    bool operator==(const ISFParticle& rhs) const;
    bool isEqual(const ISFParticle& rhs) const;
    bool isIdent(const ISFParticle& rhs) const;

    const Amg::Vector3D& momentum() const;

    const Amg::Vector3D& position() const;

    void updatePosition(const Amg::Vector3D& position);

    void updateMomentum(const Amg::Vector3D& momentum);

    double mass() const;

    double charge() const;

    double timeStamp() const;

    int pdgCode() const;

    double ekin() const;

    const ParticleHistory& history() const;
    AtlasDetDescr::AtlasRegion  originGeoID() const;
    SimSvcID                    originSimID() const;
    AtlasDetDescr::AtlasRegion  prevGeoID() const;
    SimSvcID                    prevSimID() const;
    AtlasDetDescr::AtlasRegion  nextGeoID() const;
    SimSvcID                    nextSimID() const;
    void                        setNextGeoID(AtlasDetDescr::AtlasRegion geoID);
    void                        setNextSimID(SimSvcID simID);

    int barcode() const; // FIXME barcode-based
    void setBarcode(int bc); // FIXME barcode-based

    int id() const;
    void setId(int id);

    const TruthBinding* getTruthBinding() const;
    TruthBinding* getTruthBinding();
    void          setTruthBinding(TruthBinding *truth);

    inline const HepMcParticleLink* getParticleLink() const {return  m_partLink;};
    inline void setParticleLink(const HepMcParticleLink* partLink) {m_partLink=partLink;};

    ParticleOrder  getOrder() const;
    void           setOrder(ParticleOrder order);

    const ParticleUserInformation* getUserInformation() const;
    ParticleUserInformation* getUserInformation();
    void                     setUserInformation(ParticleUserInformation *userInfo);

    MsgStream&    dump(MsgStream& out) const;
    std::ostream& dump(std::ostream& out) const;
 
    void setStatus(int a) { m_status=a; }
    int status() const { return m_status;}
     
  private :
    Amg::Vector3D                m_position;
    Amg::Vector3D                m_momentum;
    double                       m_mass;
    double                       m_charge;
    int                          m_pdgCode;
    int                          m_status;
    double                       m_tstamp;
    ParticleHistory              m_history;
    int     m_barcode; 
    int m_uid; 
    TruthBinding*                m_truth;
    ParticleOrder                m_order;                 
    ParticleUserInformation*     m_userInfo;              
    const HepMcParticleLink*     m_partLink;
  };
 
  // Overload of << operator for MsgStream for debug output
  //
  inline MsgStream&    operator << ( MsgStream& sl,    const ISF::ISFParticle& isfp) { isfp.dump(sl); return sl; }
  inline std::ostream& operator << ( std::ostream& sl, const ISF::ISFParticle& isfp) { isfp.dump(sl); return sl; }
 
} // end of namespace
 
/* implementation for inlined methods */
#include <ISF_Event/ISFParticle.icc>
 
#endif // ISF_EVENT_ISFPARTICLE_H