ParticleFlowObject.h

Go to the documentation of this file.

 
#ifndef PANDORA_PARTICLE_FLOW_OBJECT_H
#define PANDORA_PARTICLE_FLOW_OBJECT_H 1
 
#include "Pandora/ObjectCreation.h"
#include "Pandora/StatusCodes.h"
 
namespace pandora
{
 
template<typename T> class AlgorithmObjectManager;
template<typename T, typename S> class PandoraObjectFactory;
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
class ParticleFlowObject
{
public:
    int GetParticleId() const;
 
    int GetCharge() const;
 
    float GetMass() const;
 
    float GetEnergy() const;
 
    const CartesianVector &GetMomentum() const;
 
    const TrackList &GetTrackList() const;
 
    const ClusterList &GetClusterList() const;
 
    const VertexList &GetVertexList() const;
 
    TrackAddressList GetTrackAddressList() const;
 
    ClusterAddressList GetClusterAddressList() const;
 
    unsigned int GetNTracks() const;
 
    unsigned int GetNClusters() const;
 
    const PfoList &GetParentPfoList() const;
 
    const PfoList &GetDaughterPfoList() const;
 
    unsigned int GetNParentPfos() const;
 
    unsigned int GetNDaughterPfos() const;
 
    const PropertiesMap &GetPropertiesMap() const;
 
protected:
    ParticleFlowObject(const object_creation::ParticleFlowObject::Parameters &parameters);
 
    virtual ~ParticleFlowObject();
 
    StatusCode AlterMetadata(const object_creation::ParticleFlowObject::Metadata &metadata);
 
    template <typename T>
    StatusCode AddToPfo(const T *const pT);
 
    template <typename T>
    StatusCode RemoveFromPfo(const T *const pT);
 
    StatusCode AddParent(const ParticleFlowObject *const pPfo);
 
    StatusCode AddDaughter(const ParticleFlowObject *const pPfo);
 
    StatusCode RemoveParent(const ParticleFlowObject *const pPfo);
 
    StatusCode RemoveDaughter(const ParticleFlowObject *const pPfo);
 
    StatusCode UpdatePropertiesMap(const object_creation::ParticleFlowObject::Metadata &metadata);
 
    int                     m_particleId;               
    int                     m_charge;                   
    float                   m_mass;                     
    float                   m_energy;                   
    CartesianVector         m_momentum;                 
    TrackList               m_trackList;                
    ClusterList             m_clusterList;              
    VertexList              m_vertexList;               
    PfoList                 m_parentPfoList;            
    PfoList                 m_daughterPfoList;          
    PropertiesMap           m_propertiesMap;            
 
    friend class ParticleFlowObjectManager;
    friend class AlgorithmObjectManager<ParticleFlowObject>;
    friend class PandoraObjectFactory<object_creation::ParticleFlowObject::Parameters, object_creation::ParticleFlowObject::Object>;
};
 
typedef ParticleFlowObject Pfo;                         
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline int ParticleFlowObject::GetParticleId() const
{
    return m_particleId;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline int ParticleFlowObject::GetCharge() const
{
    return m_charge;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline float ParticleFlowObject::GetMass() const
{
    return m_mass;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline float ParticleFlowObject::GetEnergy() const
{
    return m_energy;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const CartesianVector &ParticleFlowObject::GetMomentum() const
{
    return m_momentum;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const TrackList &ParticleFlowObject::GetTrackList() const
{
    return m_trackList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const ClusterList &ParticleFlowObject::GetClusterList() const
{
    return m_clusterList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const VertexList &ParticleFlowObject::GetVertexList() const
{
    return m_vertexList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline unsigned int ParticleFlowObject::GetNTracks() const
{
    return m_trackList.size();
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline unsigned int ParticleFlowObject::GetNClusters() const
{
    return m_clusterList.size();
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const PfoList &ParticleFlowObject::GetParentPfoList() const
{
    return m_parentPfoList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const PfoList &ParticleFlowObject::GetDaughterPfoList() const
{
    return m_daughterPfoList;
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline unsigned int ParticleFlowObject::GetNParentPfos() const
{
    return m_parentPfoList.size();
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline unsigned int ParticleFlowObject::GetNDaughterPfos() const
{
    return m_daughterPfoList.size();
}
 
//------------------------------------------------------------------------------------------------------------------------------------------
 
inline const PropertiesMap &ParticleFlowObject::GetPropertiesMap() const
{
    return m_propertiesMap;
}
 
} // namespace pandora
 
#endif // #ifndef PANDORA_PARTICLE_FLOW_OBJECT_H