IParticlePropertySvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2023 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/IInterface.h>
#include <GaudiKernel/Kernel.h>
#include <vector>
 
namespace Gaudi {
  class ParticleID;
  class ParticleProperty;
} // namespace Gaudi
 
namespace Gaudi::Interfaces {
  class GAUDI_API IParticlePropertySvc : public extend_interfaces<IInterface> {
  public:
    DeclareInterfaceID( Gaudi::Interfaces::IParticlePropertySvc, 2, 0 );

    typedef std::vector<const Gaudi::ParticleProperty*> ParticleProperties;
    typedef ParticleProperties::const_iterator iterator;

    virtual iterator begin() const = 0;
    virtual iterator end() const = 0;
    virtual size_t size() const = 0;
    virtual const ParticleProperty* find( const std::string& name ) const = 0; // find by particle name
    virtual const ParticleProperty* find( const Gaudi::ParticleID& pid ) const = 0; // find by Gaudi::ParticleID

    template <class PREDICATE, class OUTPUT>
    OUTPUT get( const PREDICATE& cut, OUTPUT output ) const;

    virtual std::string cc( const std::string& decay ) const = 0;
  };
} // namespace Gaudi::Interfaces
 
namespace Gaudi {
  namespace ParticleProperties {
    size_t index( const Gaudi::ParticleProperty* property, const Gaudi::Interfaces::IParticlePropertySvc* service );

    size_t index( const Gaudi::ParticleID& pid, const Gaudi::Interfaces::IParticlePropertySvc* service );

    const Gaudi::ParticleProperty* particle( const size_t                                   index,
                                             const Gaudi::Interfaces::IParticlePropertySvc* service );

    const Gaudi::ParticleID particleID( const size_t index, const Gaudi::Interfaces::IParticlePropertySvc* service );

    const Gaudi::ParticleProperty* byPythiaID( const int pythia, const Gaudi::Interfaces::IParticlePropertySvc* svc );

    const Gaudi::ParticleProperty* byEvtGenName( const std::string&                             evtGen,
                                                 const Gaudi::Interfaces::IParticlePropertySvc* svc );

    template <class INPUT, class PREDICATE, class OUTPUT>
    OUTPUT get( INPUT first, INPUT last, const PREDICATE& cut, OUTPUT output ) {
      for ( ; first != last; ++first ) {
        if ( cut( *first ) ) {
          *output = *first;
          ++output;
        }
      }
      return output;
    }

    template <class PREDICATE, class OUTPUT>
    OUTPUT get( const Gaudi::Interfaces::IParticlePropertySvc* service, const PREDICATE& cut, OUTPUT output ) {
      if ( 0 == service ) { return output; }
      return service->get( cut, output );
    }

    Gaudi::Interfaces::IParticlePropertySvc::ParticleProperties
    allProperties( const Gaudi::Interfaces::IParticlePropertySvc* service );
  } // namespace ParticleProperties
 
  namespace Interfaces {
    // get the properties according to some criteria
    template <class PREDICATE, class OUTPUT>
    OUTPUT IParticlePropertySvc::get( const PREDICATE& cut, OUTPUT output ) const {
      iterator first = this->begin();
      iterator last  = this->end();
      return Gaudi::ParticleProperties::get( first, last, cut, output );
    }
  } // namespace Interfaces
} // namespace Gaudi