Event/xAOD/xAODBase/xAODBase/IParticle.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAODBASE_IPARTICLE_H
#define XAODBASE_IPARTICLE_H
 
// ROOT include(s):
#include <TLorentzVector.h>
 
// EDM include(s):
#include "AthContainers/AuxElement.h"
#include "AthContainers/Accessor.h"
 
// Local include(s):
#include "ObjectType.h"
 

namespace xAOD {
   
   class IParticle : public SG::AuxElement {
 
   public:
      virtual ~IParticle() = default;
      IParticle() = default;
      IParticle(const IParticle&) = default;
      IParticle& operator=(const IParticle&) = default;
      IParticle(IParticle&&) = delete;
      IParticle& operator=(IParticle&&) = delete;


      virtual double           pt() const = 0;
      virtual double           eta() const = 0;
      virtual double           phi() const = 0;
      virtual double           m() const = 0;
      virtual double           e() const = 0;
      virtual double           rapidity() const = 0;

      typedef TLorentzVector FourMom_t;

      virtual FourMom_t        p4() const = 0;

 

      virtual Type::ObjectType type() const = 0;
 


      template< class T >
      XAOD_AUXDATA_DEPRECATED
      T& auxdata( const std::string& name,
                  const std::string& clsname = "" ) {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

      template< class T >
      XAOD_AUXDATA_DEPRECATED
      const T& auxdata( const std::string& name,
                        const std::string& clsname = "" ) const {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

      template< class T >
      XAOD_AUXDATA_DEPRECATED
      bool isAvailable( const std::string& name,
                        const std::string& clsname = "" ) const {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

      template< class T >
      XAOD_AUXDATA_DEPRECATED
      bool isAvailableWritable( const std::string& name,
                                const std::string& clsname = "" ) const {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

 
 
   protected:
      // Hide some functions from the regular xAOD users
      using SG::AuxElement::getConstStore;
      using SG::AuxElement::getStore;
 
      // Hide the Accessor class from the regular xAOD users
      using SG::AuxElement::Accessor;
 
   }; // class IParticle
 
} // namespace xAOD
 
#ifndef XAOD_STANDALONE
#include "AthenaKernel/BaseInfo.h"
SG_BASE (xAOD::IParticle, SG::AuxElement);
#endif // not XAOD_STANDALONE
 
#endif // XAODBASE_IPARTICLE_H