MCParticle.h

Go to the documentation of this file.

 
#ifndef PANDORA_MC_PARTICLE_H
#define PANDORA_MC_PARTICLE_H 1
 
#include "Pandora/ObjectCreation.h"
#include "Pandora/StatusCodes.h"
 
namespace pandora
{
 
template<typename T> class InputObjectManager;
template<typename T, typename S> class PandoraObjectFactory;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class MCParticle 
{
public:
    bool IsRootParticle() const;
 
    bool IsPfoTarget() const;
 
    float GetEnergy() const;
 
    const CartesianVector &GetMomentum() const;
 
    const CartesianVector &GetVertex() const;
 
    const CartesianVector &GetEndpoint() const;
 
    float GetInnerRadius() const;
 
    float GetOuterRadius() const;
 
    int GetParticleId() const;
 
    MCParticleType GetMCParticleType() const;
 
    bool IsPfoTargetSet() const;
 
    const MCParticle *GetPfoTarget() const;
 
    Uid GetUid() const;
 
    const MCParticleList &GetParentList() const;
 
    const MCParticleList &GetDaughterList() const;
 
    bool operator< (const MCParticle &rhs) const;
 
protected:
    MCParticle(const object_creation::MCParticle::Parameters &parameters);
 
    virtual ~MCParticle();
 
    StatusCode AddDaughter(const MCParticle *const pMCParticle);
 
    StatusCode AddParent(const MCParticle *const pMCParticle);
 
    StatusCode RemoveDaughter(const MCParticle *const pMCParticle);
 
    StatusCode RemoveParent(const MCParticle *const pMCParticle);
 
    StatusCode SetPfoTarget(const MCParticle *const pMCParticle);
 
    StatusCode RemovePfoTarget();
 
    const Uid               m_uid;                      
    const float             m_energy;                   
    const CartesianVector   m_momentum;                 
    const CartesianVector   m_vertex;                   
    const CartesianVector   m_endpoint;                 
    const float             m_innerRadius;              
    const float             m_outerRadius;              
    const int               m_particleId;               
    const MCParticleType    m_mcParticleType;           
    const MCParticle       *m_pPfoTarget;               
    MCParticleList          m_daughterList;             
    MCParticleList          m_parentList;               
 
    friend class MCManager;
    friend class InputObjectManager<MCParticle>;
    friend class PandoraObjectFactory<object_creation::MCParticle::Parameters, object_creation::MCParticle::Object>;
};
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline bool MCParticle::IsRootParticle() const
{
    return m_parentList.empty();
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline bool MCParticle::IsPfoTarget() const
{
    return (this == m_pPfoTarget);
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline bool MCParticle::IsPfoTargetSet() const
{
    return (nullptr != m_pPfoTarget);
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline Uid MCParticle::GetUid() const
{
   return m_uid;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline float MCParticle::GetEnergy() const
{
    return m_energy;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const CartesianVector &MCParticle::GetMomentum() const
{
    return m_momentum;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const CartesianVector &MCParticle::GetVertex() const
{
    return m_vertex;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const CartesianVector &MCParticle::GetEndpoint() const
{
    return m_endpoint;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline float MCParticle::GetInnerRadius() const
{
    return m_innerRadius;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline float MCParticle::GetOuterRadius() const
{
    return m_outerRadius;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline int MCParticle::GetParticleId() const
{
    return m_particleId;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline MCParticleType MCParticle::GetMCParticleType() const
{
    return m_mcParticleType;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const MCParticleList &MCParticle::GetParentList() const
{
    return m_parentList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const MCParticleList &MCParticle::GetDaughterList() const
{
    return m_daughterList;
}
 
} // namespace pandora
 
#endif // #ifndef PANDORA_MC_PARTICLE_H