TruthParticleBase.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// TruthParticleBase.h 
// Header file for class TruthParticleBase
// Author: S.Binet<binet@cern.ch>
#ifndef MCPARTICLEEVENT_TRUTHPARTICLEBASE_H 
#define MCPARTICLEEVENT_TRUTHPARTICLEBASE_H 
 
// STL includes
 
// HepMC / CLHEP includes
#include "AtlasHepMC/GenParticle.h"
 
// Gaudi includes
 
// EventKernel includes
#include "EventKernel/IParticle.h" // for {Charge,ParticleDataType::Data}Type
 
// Navigation includes
#include "Navigation/AthenaBarCodeImpl.h"
#include "AthLinks/ElementLink.h"
#include "VxVertex/VxContainer.h"
 
// Forward declaration
namespace Trk   { class RecVertex; }
namespace Trk   { class VxCandidate;}
 
class TruthParticleBase
{ 

  // Public methods: 
 public: 

  TruthParticleBase();

  TruthParticleBase( const TruthParticleBase& rhs );

  TruthParticleBase& operator=( const TruthParticleBase& rhs ); 

  TruthParticleBase( const HepMC::GenParticlePtr mc );

  ~TruthParticleBase(); 

  // Const methods: 


  ParticleDataType::DataType dataType() const;

  const Trk::RecVertex* origin() const;

  const ElementLink<VxContainer>& originLink() const;

  bool hasCharge() const;

  ChargeType charge() const;

  bool hasPdgId() const;

  int pdgId() const;

  std::ostream& dump( std::ostream& out ) const;


  HepMC::ConstGenParticlePtr genParticle() const;

  const AthenaBarCodeImpl& getAthenaBarCodeImpl() const {return m_abc;}

  // Non-const methods: 

  void setCharge( const ChargeType charge );
  
  void setGenParticle( HepMC::ConstGenParticlePtr particle );

  AthenaBarCodeImpl& getAthenaBarCodeImpl() {return m_abc;}
 
  // Set functions (for IParticle) (all dummy)
  void set_dataType( ParticleDataType::DataType /*x*/ ) {std::abort();}
  void set_charge( ChargeType x ) {setCharge(x);}
  void set_pdgId( int /*x*/ ) {std::abort();}
  void set_origin( const VxContainer* /*theContainer*/, int /*index*/ )
  {std::abort();}
  void set_origin( const VxContainer* /*theContainer*/,
                   const Trk::VxCandidate * /*vertex*/ )
  {std::abort();}

  // Private data: 
 private: 

  ChargeType m_charge;

  HepMC::ConstGenParticlePtr m_genParticle;

  AthenaBarCodeImpl m_abc;
 
}; 

// Inline methods: 
 
inline 
ParticleDataType::DataType TruthParticleBase::dataType() const
{
  return ParticleDataType::True;
}
 
inline 
bool TruthParticleBase::hasCharge() const
{
  return true;
}
 
inline 
ChargeType TruthParticleBase::charge() const
{
  return m_charge;
}
      
inline 
bool TruthParticleBase::hasPdgId() const
{
  return true;
}
 
inline 
int TruthParticleBase::pdgId() const
{
  return m_genParticle->pdg_id();
}
 
inline 
HepMC::ConstGenParticlePtr TruthParticleBase::genParticle() const
{
  return m_genParticle;
}
 
inline 
void TruthParticleBase::setCharge( const ChargeType charge )
{
  m_charge = charge;
}
 
inline 
void TruthParticleBase::setGenParticle(  HepMC::ConstGenParticlePtr mc )
{
  m_genParticle = std::move(mc);
}
 
#endif //> MCPARTICLEEVENT_TRUTHPARTICLEBASE_H