Const::ParticleSet Class Reference

A set of ParticleType objects, with defined order. More...

#include <Const.h>

Collaboration diagram for Const::ParticleSet:

Public Member Functions
	ParticleSet ()=default
	Emtpy constructor.
	ParticleSet (const ParticleSet &other)
	Copy constructor to make sure particles belong to correct set.
ParticleSet &	operator= (const ParticleSet &other)
	Assignment operator.
void	add (const ParticleType &p)
	Add a copy of the given ParticleType to this set.
bool	contains (const ParticleType &p) const
	Returns true if and only if the set contains 'p'.
unsigned int	size () const
	Returns number of particles in this set.
const ParticleType &	at (unsigned int index) const
	Return particle at given index, or end() if out of range.
ParticleType	begin () const
	Returns first particle.
ParticleType	end () const
	Returns an invalid particle to check if iteration should be stopped.
const ParticleType &	find (int pdg) const
	Returns particle in set with given PDG code, or invalidParticle if not found.

Private Attributes
std::vector< ParticleType >	m_particles
	Actual particles.

Detailed Description

A set of ParticleType objects, with defined order.

Allows easy iteration over a set of particles, e.g. to print indices and PDG codes:

B2INFO("index -> PDG code");
const Const::ParticleSet set = Const::chargedStableSet;
//via range-based for
for(const Const::ChargedStable& pdgIter : set) {
  B2INFO(pdgIter.getIndex() << " -> " << pdgIter.getPDGCode());
}
//or, using iterator syntax:
for(Const::ChargedStable pdgIter = set.begin(); pdgIter != set.end(); ++pdgIter) {
  B2INFO(pdgIter.getIndex() << " -> " << pdgIter.getPDGCode());
}

ParticleSets can be created by merging ParticleType objects or other ParticleSets:

Const::ParticleSet set = Const::electron + Const::muon;
Const::ParticleSet set2 = set + Const::photon;

Definition at line 517 of file Const.h.

Constructor & Destructor Documentation

ParticleSet()

ParticleSet ( const ParticleSet &  other )

inline

Copy constructor to make sure particles belong to correct set.

Definition at line 523 of file Const.h.

      {
        for (const ParticleType& pdgIter : other) add(pdgIter);
      }

Member Function Documentation

add()

void add

(

const ParticleType &

p

)

Add a copy of the given ParticleType to this set.

If the set already contains the given particle, it remains unchanged.

Definition at line 417 of file UnitConst.cc.

{
  if (contains(p))
    return;
  m_particles.emplace_back(p.getPDGCode(), this, m_particles.size());
}

at()

const ParticleType & at ( unsigned int  index ) const

inline

Return particle at given index, or end() if out of range.

Definition at line 549 of file Const.h.

      {
        if (index < m_particles.size())
          return m_particles[index];
        return invalidParticle;
      }

begin()

ParticleType begin ( ) const

inline

Returns first particle.

Definition at line 557 of file Const.h.

      {
        if (m_particles.empty())
          return end();
        return m_particles[0];
      }

contains()

bool contains

(

const ParticleType &

p

)

const

Returns true if and only if the set contains 'p'.

Definition at line 424 of file UnitConst.cc.

{
  return (std::find(m_particles.begin(), m_particles.end(), p) != m_particles.end());
}

end()

ParticleType end ( ) const

inline

Returns an invalid particle to check if iteration should be stopped.

Definition at line 565 of file Const.h.

      {
        return invalidParticle;
      }

find()

const ParticleType & find ( int  pdg ) const

inline

Returns particle in set with given PDG code, or invalidParticle if not found.

Definition at line 571 of file Const.h.

      {
        for (ParticleType pdgIter : *this) {
          if (pdgIter.getPDGCode() == pdg)
            return m_particles[pdgIter.getIndex()];
        }
 
        return invalidParticle;
      }

operator=()

ParticleSet & operator= ( const ParticleSet &  other )

inline

Assignment operator.

Definition at line 529 of file Const.h.

      {
        m_particles.clear();
        for (const ParticleType& pdgIter : other) add(pdgIter);
        return *this;
      }

size()

unsigned int size ( ) const

inline

Returns number of particles in this set.

Definition at line 546 of file Const.h.

{ return m_particles.size(); }

Member Data Documentation

m_particles

std::vector<ParticleType> m_particles

private

Actual particles.

Definition at line 581 of file Const.h.

---

The documentation for this class was generated from the following files:

• framework/gearbox/include/Const.h
• framework/gearbox/src/UnitConst.cc