Decay.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 <Gaudi/ParticleID.h>
#include <GaudiKernel/StatusCode.h>
#include <string>
#include <vector>
 
namespace Gaudi {
  namespace Interfaces {
    class IParticlePropertySvc;
  }
  class ParticleProperty;
} // namespace Gaudi
 
namespace Gaudi::Decays {
  class GAUDI_API Decay final {
  public:
    class Item final {
    public:
      Item( const Gaudi::ParticleProperty* pp = 0 );
      Item( const std::string& name );
      Item( const Gaudi::ParticleID& pid );
 
      const std::string& name() const { return m_name; }
      const Gaudi::ParticleID& pid() const { return m_pid; }
      const Gaudi::ParticleProperty* pp() const { return m_pp; }
 
      std::ostream& fillStream( std::ostream& s ) const;
 
      StatusCode validate( const Gaudi::Interfaces::IParticlePropertySvc* svc ) const;
      StatusCode validate( const Gaudi::ParticleProperty* prop ) const;
 
    private:
      mutable std::string m_name;
      mutable Gaudi::ParticleID m_pid;
      mutable const Gaudi::ParticleProperty* m_pp = nullptr;
    };
 
    typedef std::vector<Item> Items;
 
  public:
    Decay() = default;
 
    Decay( const Gaudi::ParticleProperty* mother, const std::vector<const Gaudi::ParticleProperty*>& daughters );
 
    Decay( const std::string& mother, const std::vector<std::string>& daughters );
    Decay( const Gaudi::ParticleID& mother, const std::vector<Gaudi::ParticleID>& daughters );
 
    Decay( const Item& mother, const std::vector<Item>& daughters );
 
    const Item& mother() const { return m_mother; }
    const Items& daughters() const { return m_daughters; }
    const Items& children() const { return daughters(); }
    size_t nDaughters() const { return m_daughters.size(); }
    size_t nChildren() const { return m_daughters.size(); }
    const Item& operator()( const unsigned int index ) const;
    const Item& operator[]( const unsigned int index ) const { return ( *this )( index ); }
 
    void setMother( const Item& mom );
    void setMother( const Gaudi::ParticleProperty* mom );
    void setMother( const std::string& mom );
    void setMother( const Gaudi::ParticleID& mom );
    void setDaughters( const Items& daugs );
    void setDaughters( const std::vector<const Gaudi::ParticleProperty*>& daugs );
    void setDaughters( const std::vector<std::string>& daugs );
    void setDaughters( const std::vector<Gaudi::ParticleID>& daugs );
    void setChildren( const Items& daugs ) { setDaughters( daugs ); }
    void setChildren( const std::vector<const Gaudi::ParticleProperty*>& daugs ) { setDaughters( daugs ); }
    void setChildren( const std::vector<std::string>& daugs ) { setDaughters( daugs ); }
    void setChidlren( const std::vector<Gaudi::ParticleID>& daugs ) { setDaughters( daugs ); }
 
    Decay& operator+=( const std::string& child );
    Decay& operator+=( const Gaudi::ParticleID& child );
    Decay& operator+=( const Gaudi::ParticleProperty* child );
    Decay& operator+=( const Item& child );
 
    StatusCode validate( const Gaudi::Interfaces::IParticlePropertySvc* svc ) const;
 
    std::ostream& fillStream( std::ostream& s ) const;
    std::string toString() const;
 
    mutable Item m_mother; // the head of the decay
    mutable Items m_daughters; // the daughter particles
  };
} // namespace Gaudi::Decays
 
inline std::ostream& operator<<( std::ostream& s, const Gaudi::Decays::Decay& decay ) { return decay.fillStream( s ); }
 
inline std::ostream& operator<<( std::ostream& s, const Gaudi::Decays::Decay::Item& item ) {
  return item.fillStream( s );
}