This service provides access to particle properties. More...

#include <ParticlePropertySvc.cpp>

Inheritance diagram for Gaudi::ParticlePropertySvc:

[legend]

Collaboration diagram for Gaudi::ParticlePropertySvc:

[legend]

Public Types
typedef std::set< std::unique_ptr< Gaudi::ParticleProperty > >	Set
	the actual storage of all properties

typedef GaudiUtils::VectorMap< std::string, const Gaudi::ParticleProperty * >	NameMap
	the actual type of map: { "name" : "property" }

typedef GaudiUtils::VectorMap< Gaudi::ParticleID, const Gaudi::ParticleProperty * >	PidMap
	the actual type of map: { "pid" : "property" }

typedef Gaudi::Interfaces::IParticlePropertySvc::ParticleProperties	Vector

typedef std::vector< std::string >	Files
	the actual type for the list of files

typedef std::vector< std::string >	Particles
	the actual type for the list of particle properties (strings)

typedef std::set< std::string >	NameSet

typedef std::set< Gaudi::ParticleID >	PidSet

Public Types inherited from extends< Service, Gaudi::Interfaces::IParticlePropertySvc >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Public Member Functions
iterator	begin () const override
	get the begin-iterator for the container of particle properties It is assumed that the container is properly ordered

iterator	end () const override
	get the end-iterator for the container of particle properties It is assumed that the container is properly ordered

size_t	size () const override
	get the container size.

const Gaudi::ParticleProperty *	find (const std::string &name) const override
	Retrieve an object by name:

const Gaudi::ParticleProperty *	find (const Gaudi::ParticleID &pid) const override
	Retrieve an object by PID:

std::string	cc (const std::string &decay) const override
	make the charge conjugation for the string/decay descriptor

StatusCode	initialize () override
	Initialize the service.

	ParticlePropertySvc (const std::string &name, ISvcLocator *pSvc)
	Standard Constructor.

void	updateHandler (Gaudi::Details::PropertyBase &p)
	the action in the case of interactive manipulation with properties:

void	updateDump (Gaudi::Details::PropertyBase &p)
	the action in the case of interactive manipulation with properties: of the service

void	updateCC (Gaudi::Details::PropertyBase &p)
	the action in the case of interactive manipulation with properties: of the service

void	dump ()
	dump the table of particle properties

StatusCode	rebuild ()
	rebuild the Particle Property Data

StatusCode	parse (const std::string &file)
	parse the file

StatusCode	parseLine (const std::string &line)
	parse the line

StatusCode	addParticle (const std::string &pname, const Gaudi::ParticleID &pid, const double charge, const double mass, const double tlife, const double maxWidth, const std::string &evtgen, const int pythia)
	add new particle (or redefine the existing one)

StatusCode	setAntiParticles ()
	set properly particle<-->antiparticle relations

bool	diff (const Gaudi::ParticleProperty &n, const Gaudi::ParticleProperty &o)
	check the difference of two properties and fill corresponding sets

Public Member Functions inherited from extends< Service, Gaudi::Interfaces::IParticlePropertySvc >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Public Attributes
Set	m_set
	the actual storage of all particle properties

Vector	m_vector
	"visible" data (the ordered container)

NameMap	m_nameMap
	Map: { "name" : "property" }.

PidMap	m_pidMap
	Map: { "pid" : "property" }.

Gaudi::Property< bool >	m_dump
	dump the table?

Gaudi::Property< std::string >	m_filename
	the main file with particle properties

Gaudi::Property< Files >	m_other
	additional files

Gaudi::Property< Particles >	m_particles
	properties to be redefined explicitly

Decays::CC::MapCC	m_ccMap
	the CC-map

Gaudi::Property< std::map< std::string, std::string > >	m_ccmap_
	CC-map for properties.

NameSet	m_by_charge

NameSet	m_by_mass

NameSet	m_by_tlife

NameSet	m_by_width

NameSet	m_by_evtgen

NameSet	m_by_pythia

NameSet	m_replaced_names

PidSet	m_replaced_pids

NameSet	m_no_anti

Vector	m_modified

Additional Inherited Members
Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

This service provides access to particle properties.

The settable property of this service is the ParticlePropertiesFile, an ASCII file containing the list of properties for the particles. The default file is: "$PARAMFILESROOT/data/ParticleTable.txt" or if $PARAMFILESROOT is not defined "ParticleTable.txt"

Author: Iain Last; Gloria Corti; Vanya BELYAEV

Date: 2006-09-22

1) Modified to add possibility to redefine properties of existing particles and to read addiitonal files. New propeety "OtherFiles" (default is empty vector) is introduces. Service parsed additional files after the main one.

// read the additional files with particle properties
ParticlePropertySvc.OtherFiles += {
   "$SOMELOCATION1/file1.txt" ,
   "$SOMELOCATION2/file2.txt"
} ;

2) Add possibility to modify only certain partiles through the new property "Particles" (default is enpty list), Each line is interpreted as a line in particle data table, e.g.

// redefine the properties of H_20 and H_30 particles:
ParticlePropertySvc.Particles = {
    "H_20 88 35 0.0 120.0 9.4e-26 Higgs'0 35 0.0e+00" ,
    "H_30 89 36 0.0  40.0 1.0e-12      A0 36 0.0e+00"
  } ;

The replaces/modified particles are reported.

Definition at line 92 of file ParticlePropertySvc.cpp.

Member Typedef Documentation

◆ Files

typedef std::vector<std::string> Gaudi::ParticlePropertySvc::Files

the actual type for the list of files

Definition at line 249 of file ParticlePropertySvc.cpp.

◆ NameMap

typedef GaudiUtils::VectorMap<std::string, const Gaudi::ParticleProperty*> Gaudi::ParticlePropertySvc::NameMap

the actual type of map: { "name" : "property" }

Definition at line 232 of file ParticlePropertySvc.cpp.

◆ NameSet

typedef std::set<std::string> Gaudi::ParticlePropertySvc::NameSet

Definition at line 276 of file ParticlePropertySvc.cpp.

◆ Particles

typedef std::vector<std::string> Gaudi::ParticlePropertySvc::Particles

the actual type for the list of particle properties (strings)

Definition at line 251 of file ParticlePropertySvc.cpp.

◆ PidMap

typedef GaudiUtils::VectorMap<Gaudi::ParticleID, const Gaudi::ParticleProperty*> Gaudi::ParticlePropertySvc::PidMap

the actual type of map: { "pid" : "property" }

Definition at line 234 of file ParticlePropertySvc.cpp.

◆ PidSet

typedef std::set<Gaudi::ParticleID> Gaudi::ParticlePropertySvc::PidSet

Definition at line 277 of file ParticlePropertySvc.cpp.

◆ Set

typedef std::set<std::unique_ptr<Gaudi::ParticleProperty> > Gaudi::ParticlePropertySvc::Set

the actual storage of all properties

Definition at line 230 of file ParticlePropertySvc.cpp.

◆ Vector

typedef Gaudi::Interfaces::IParticlePropertySvc::ParticleProperties Gaudi::ParticlePropertySvc::Vector

Definition at line 235 of file ParticlePropertySvc.cpp.

Constructor & Destructor Documentation

◆ ParticlePropertySvc()

Gaudi::ParticlePropertySvc::ParticlePropertySvc	(	const std::string &	name,
		ISvcLocator *	pSvc )

inline

Standard Constructor.

Parameters

name	service instance name
pSvc	pointer to service locator `

Definition at line 160 of file ParticlePropertySvc.cpp.

162 : base_class( name, pSvc ) {}

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition Service.cpp:333

extends< Service, Gaudi::Interfaces::IParticlePropertySvc >::base_class

extends base_class

Definition extends.h:23

Member Function Documentation

◆ addParticle()

StatusCode Gaudi::ParticlePropertySvc::addParticle	(	const std::string &	pname,
		const Gaudi::ParticleID &	pid,
		const double	charge,
		const double	mass,
		const double	tlife,
		const double	maxWidth,
		const std::string &	evtgen,
		const int	pythia )

add new particle (or redefine the existing one)

Parameters

pname	the particle name
pid	the particle ID
charge	the particle charge
mass	the particle mass
tlife	the particle tlife
maxWidth	the particle max-width
evtgen	the name for EvtGen
pythia	the ID for pythia generator

Definition at line 517 of file ParticlePropertySvc.cpp.

                                                                       {
  // create the local object
  const Gaudi::ParticleProperty pp( pname, pid, charge, mass, tlife, maxWidth, evtgen, pythia );
 
  // 1) find the object with same name & pid in set:
  auto it = std::find_if( m_set.begin(), m_set.end(), [&]( const std::unique_ptr<Gaudi::ParticleProperty>& s ) {
    return s->name() == pp.name() && s->pid() == pp.pid();
  } );
  // 2) object is found, redefine it!
  Gaudi::ParticleProperty* newp = nullptr;
  if ( m_set.end() != it ) { newp = it->get(); }
  // new property ?
  if ( !newp ) {
    it   = m_set.insert( std::make_unique<Gaudi::ParticleProperty>( pp ) ).first;
    newp = it->get();
  } else if ( diff( *newp, pp ) ) {
    *newp = pp; // NB: redefine the properties
  }
 
  // insert into name map
  {
    auto i1 = m_nameMap.find( newp->name() );
    if ( m_nameMap.end() != i1 && i1->second != newp ) { m_replaced_names.insert( newp->name() ); }
    m_nameMap.update( newp->name(), newp );
  }
  // insert into PID map
  {
    auto i2 = m_pidMap.find( newp->pid() );
    if ( m_pidMap.end() != i2 && i2->second != newp ) { m_replaced_pids.insert( newp->pid() ); }
    m_pidMap.update( newp->pid(), newp );
  }
  // insert into vector
  if ( m_vector.end() == std::find( m_vector.begin(), m_vector.end(), newp ) ) { m_vector.push_back( newp ); }
 
  m_modified.push_back( newp );
 
  return StatusCode::SUCCESS;
}

◆ begin()

iterator Gaudi::ParticlePropertySvc::begin ( ) const

inlineoverride

get the begin-iterator for the container of particle properties It is assumed that the container is properly ordered

Returns: begin-iterator for the container of particle properties

Definition at line 97 of file ParticlePropertySvc.cpp.

97{ return m_vector.begin(); }

◆ cc()

std::string Gaudi::ParticlePropertySvc::cc ( const std::string & decay ) const

override

make the charge conjugation for the string/decay descriptor

std::string decay = "B0 -> pi+ pi-" ;
 
Gaudi::IParticleProeprtySvc* svc = ... ;
 
std::string cc = svc -> cc ( decay ) ;

Parameters

decay the decay descriptor

Returns: the charge conjugation for the decay descriptor

Definition at line 647 of file ParticlePropertySvc.cpp.

                                                                     {
  // build the map if not done yet
  if ( m_ccMap.empty() ) {
    // get the particles from the service
    for ( const auto& pp : m_vector ) {
      if ( !pp ) { continue; }
      const Gaudi::ParticleProperty* anti = pp->antiParticle();
      if ( !anti ) { continue; }
      m_ccMap[pp->particle()] = anti->particle();
    }
    // get the particles from the options
    for ( const auto& ic : m_ccmap_.value() ) {
      m_ccMap[ic.first]  = ic.second;
      m_ccMap[ic.second] = ic.first;
    }
    if ( msgLevel( MSG::DEBUG ) ) {
      Gaudi::Utils::toStream( m_ccMap, ( debug() << " CC-map is \n" ).stream() );
      debug() << endmsg;
    }
  }
  // use the map
  return Decays::CC::cc( decay, m_ccMap );
}

◆ diff()

bool Gaudi::ParticlePropertySvc::diff	(	const Gaudi::ParticleProperty &	n,
		const Gaudi::ParticleProperty &	o )

check the difference of two properties and fill corresponding sets

Definition at line 587 of file ParticlePropertySvc.cpp.

                                                                                                    {
  bool d = false;
 
  if ( different( n.charge(), o.charge() ) ) {
    m_by_charge.insert( n.name() );
    d = true;
  }
  if ( different( n.mass(), o.mass() ) ) {
    m_by_mass.insert( n.name() );
    d = true;
  }
  if ( different( n.lifetime(), o.lifetime() ) ) {
    m_by_tlife.insert( n.name() );
    d = true;
  }
  if ( different( n.maxWidth(), o.maxWidth() ) ) {
    m_by_width.insert( n.name() );
    d = true;
  }
  if ( different( n.evtGen(), o.evtGen() ) ) {
    m_by_evtgen.insert( n.name() );
    d = true;
  }
  if ( different( n.pythia(), o.pythia() ) ) {
    m_by_pythia.insert( n.name() );
    d = true;
  }
 
  if ( d ) {
    MsgStream log( msgSvc(), name() );
    if ( log.level() <= MSG::DEBUG )
      log << MSG::DEBUG << " Change the properties of '" << n.name() << "'/" << n.pid().pid() << std::endl
          << " New: " << n << std::endl
          << " Old: " << o << endmsg;
  }
  return d;
}

◆ dump()

void Gaudi::ParticlePropertySvc::dump ( )

dump the table of particle properties

Definition at line 625 of file ParticlePropertySvc.cpp.

                                    {
  auto& log = always();
  log << " The Table of Particle Properties " << std::endl;
  Gaudi::ParticleProperties::printAsTable( m_vector, log, this );
  log << endmsg;
}

◆ end()

iterator Gaudi::ParticlePropertySvc::end ( ) const

inlineoverride

get the end-iterator for the container of particle properties It is assumed that the container is properly ordered

Returns: end-iterator for the container of particle properties

Definition at line 102 of file ParticlePropertySvc.cpp.

102{ return m_vector.end(); }

◆ find() [1/2]

const Gaudi::ParticleProperty * Gaudi::ParticlePropertySvc::find ( const Gaudi::ParticleID & pid ) const

inlineoverride

Retrieve an object by PID:

Gaudi::Interfaces::IParticlePropertySvc* svc = ... ;
 
const Gaudi::ParticleID& pid = ... ;
 
const Gaudi::ParticleProperty*  pp = svc -> find ( pid ) ;

Parameters

name	the particle name

Returns: pointer to particle property object

Definition at line 134 of file ParticlePropertySvc.cpp.

134{ return m_pidMap( pid ); }

◆ find() [2/2]

const Gaudi::ParticleProperty * Gaudi::ParticlePropertySvc::find ( const std::string & name ) const

inlineoverride

Retrieve an object by name:

Gaudi::Interfaces::IParticlePropertySvc* svc = ... ;
 
const std::string& name = ... ;
 
const Gaudi::ParticleProperty*  pp = svc -> find ( name ) ;

Parameters

name	the particle name

Returns: pointer to particle property object

Definition at line 119 of file ParticlePropertySvc.cpp.

119{ return m_nameMap( name ); }

◆ initialize()

StatusCode Gaudi::ParticlePropertySvc::initialize ( )

override

Initialize the service.

Definition at line 294 of file ParticlePropertySvc.cpp.

                                                {
  // 1) initialize the base
  StatusCode sc = Service::initialize();
  if ( sc.isFailure() ) { return sc; }
  // 2) create the log
  MsgStream log( msgSvc(), name() );
  // 3) rebuild everything
  sc = rebuild();
  log << MSG::INFO << "Initialising Gaudi ParticlePropertySvc" << endmsg;
  if ( sc.isFailure() ) {
    log << MSG::ERROR << " Unable to initialize the internal structures " << endmsg;
    return sc;
  }
 
  m_by_charge.clear();
  m_by_mass.clear();
  m_by_tlife.clear();
  m_by_width.clear();
  m_by_evtgen.clear();
  m_by_pythia.clear();
  m_replaced_names.clear();
  m_replaced_pids.clear();
  m_no_anti.clear();
 
  m_ccMap.clear();
 
  if ( m_dump.value() || msgLevel( MSG::DEBUG ) ) { dump(); }
 
  return StatusCode::SUCCESS;
}

◆ parse()

StatusCode Gaudi::ParticlePropertySvc::parse ( const std::string & file )

parse the file

Parameters

file	the file name to be parsed

Returns: status code

Definition at line 431 of file ParticlePropertySvc.cpp.

                                                                  {
  auto fileAccess = service<IFileAccess>( "VFSSvc" );
  if ( !fileAccess ) {
    error() << "Unable to locate IFileAccess('VFSSvc') service" << endmsg;
    return StatusCode::FAILURE;
  }
  // "open" the file
  auto infile = fileAccess->open( file );
  if ( !infile.get() ) {
    error() << "Unable to open file '" << file << "'" << endmsg;
    return StatusCode::FAILURE;
  }
  info() << "Opened particle properties file : " << file << endmsg;
  bool active = false;
  // read the file line-by-line
  while ( *infile ) {
    std::string line;
    std::getline( *infile, line );
    // skip empty lines:
    if ( line.empty() ) { continue; }
    // comment lines start with '#'
    if ( line[0] == '#' ) { continue; }
    //
    if ( !active ) {
      if ( "PARTICLE" == boost::to_upper_copy( boost::trim_copy( line ) ) ) {
        active = true;
        continue;
      }
    } else {
      if ( "END PARTICLE" == boost::to_upper_copy( boost::trim_copy( line ) ) ) {
        active = false;
        continue;
      }
    }
 
    if ( !active ) { continue; } // skip the lines if not active
    // parse the line
    if ( auto sc = parseLine( line ); sc.isFailure() ) {
      error() << "Unable to parse the file '" << file << "'" << endmsg;
      return sc;
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ parseLine()

StatusCode Gaudi::ParticlePropertySvc::parseLine ( const std::string & line )

parse the line

Parameters

line	the line to be parsed

Returns: status code

Definition at line 482 of file ParticlePropertySvc.cpp.

                                                                      {
  // get the input stream  from the line :
  std::istringstream input( line );
  // get the name
  std::string p_name;
  int         p_geant; // obsolete, to be ignored
  int         p_pdg;
  double      p_charge;
  double      p_mass;
  double      p_ltime;
  std::string p_evtgen;
  int         p_pythia;
  double      p_maxwid;
  // parse the line
  if ( input >> p_name >> p_geant >> p_pdg >> p_charge >> p_mass >> p_ltime >> p_evtgen >> p_pythia >> p_maxwid ) {
    // Negative lifetime means the width in GeV-units
    if ( 0 > p_ltime ) {
      p_ltime = Gaudi::Units::hbar_Planck / std::abs( p_ltime * Gaudi::Units::GeV ) / Gaudi::Units::s;
    }
 
    StatusCode sc = addParticle( p_name, Gaudi::ParticleID( p_pdg ), p_charge,
                                 p_mass * Gaudi::Units::GeV,   // rescale from CDF units
                                 p_ltime * Gaudi::Units::s,    // rescale from CDF units
                                 p_maxwid * Gaudi::Units::GeV, // rescale from CDF units
                                 p_evtgen, p_pythia );
    if ( sc.isFailure() ) { return sc; }
  } else {
    MsgStream log( msgSvc(), name() );
    log << MSG::ERROR << " could not parse the line: '" << line << "'" << endmsg;
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ rebuild()

StatusCode Gaudi::ParticlePropertySvc::rebuild ( )

rebuild the Particle Property Data

clear existing containers
parse main file
parse additional files
parse the specific options
set particle<->antiparticle links
Returns
status code

Definition at line 333 of file ParticlePropertySvc.cpp.

                                             {
  // clear all existing containers
  m_nameMap.clear();
  m_pidMap.clear();
  m_vector.clear();
  m_ccMap.clear();
 
  // parse the main file
  StatusCode sc = parse( m_filename.value() );
  if ( sc.isFailure() ) { return sc; }
  // parse the additional files
  for ( const auto& file : m_other.value() ) {
    if ( sc = parse( file ); sc.isFailure() ) { return sc; }
  }
  // parse the options/lines
  m_modified.clear();
  for ( const auto& line : m_particles.value() ) {
    if ( sc = parseLine( line ); sc.isFailure() ) { return sc; }
  }
  // sort the vector
  std::stable_sort( m_vector.begin(), m_vector.end(), Gaudi::ParticleProperty::Compare() );
  // set particle<-->antiparticle links
  sc = setAntiParticles();
  if ( sc.isFailure() ) { return sc; }
  // some debug printout
  if ( msgLevel( MSG::DEBUG ) ) {
    debug() << " All:   " << m_vector.size() << " By Name: " << m_nameMap.size() << " By PID: " << m_pidMap.size()
            << " Total: " << m_set.size() << endmsg;
  }
 
  if ( !m_modified.empty() ) {
    auto& log = always();
    log << " New/updated particles (from \"Particles\" property)" << std::endl;
    Gaudi::ParticleProperties::printAsTable( m_modified, log, this );
    log << endmsg;
    m_modified.clear();
  }
 
  if ( !m_by_charge.empty() ) {
    info() << " Charge   has beed redefined for " << Gaudi::Utils::toString( m_by_charge ) << endmsg;
  }
  if ( !m_by_mass.empty() ) {
    info() << " Mass     has beed redefined for " << Gaudi::Utils::toString( m_by_mass ) << endmsg;
  }
  if ( !m_by_tlife.empty() ) {
    info() << " Lifetime has beed redefined for " << Gaudi::Utils::toString( m_by_tlife ) << endmsg;
  }
  if ( !m_by_width.empty() ) {
    info() << " MaxWidth has beed redefined for " << Gaudi::Utils::toString( m_by_width ) << endmsg;
  }
  if ( !m_by_evtgen.empty() ) {
    info() << " EvtGenID has beed redefined for " << Gaudi::Utils::toString( m_by_evtgen ) << endmsg;
  }
  if ( !m_by_pythia.empty() ) {
    info() << " PythiaID has beed redefined for " << Gaudi::Utils::toString( m_by_pythia ) << endmsg;
  }
  if ( !m_replaced_names.empty() ) {
    info() << " Replaced names : " << Gaudi::Utils::toString( m_replaced_names ) << endmsg;
  }
  if ( !m_replaced_pids.empty() ) {
    info() << " Replaced PIDs  : " << Gaudi::Utils::toString( m_replaced_pids ) << endmsg;
  }
  if ( !m_no_anti.empty() ) { info() << " No anti particle : " << Gaudi::Utils::toString( m_no_anti ) << endmsg; }
 
  return StatusCode::SUCCESS;
}

◆ setAntiParticles()

StatusCode Gaudi::ParticlePropertySvc::setAntiParticles ( )

set properly particle<-->antiparticle relations

Returns: status code

Definition at line 559 of file ParticlePropertySvc.cpp.

                                                      {
  for ( const Gaudi::ParticleProperty* _pp : m_vector ) {
    Gaudi::ParticleProperty* pp = const_cast<Gaudi::ParticleProperty*>( _pp );
    pp->setAntiParticle( nullptr );
    // get the ID for antiParticle
    Gaudi::ParticleID panti( -pp->particleID().pid() );
    //
    const Gaudi::ParticleProperty* anti = m_pidMap( panti );
    //
    if ( !anti && 0 < pp->particleID().pid() && !pp->particleID().isNucleus() ) { anti = _pp; }
    //
    pp->setAntiParticle( anti );
    if ( pp->antiParticle() ) {
      if ( msgLevel( MSG::VERBOSE ) )
        verbose() << "Antiparticle for \n" << ( *pp ) << " is set to be    \n" << ( *( pp->antiParticle() ) ) << endmsg;
    }
    if ( ( !pp->antiParticle() ) && ( 0 == pp->pid().extraBits() ) ) { m_no_anti.insert( pp->name() ); }
  }
  return StatusCode::SUCCESS;
}

◆ size()

size_t Gaudi::ParticlePropertySvc::size ( ) const

inlineoverride

get the container size.

Definition at line 104 of file ParticlePropertySvc.cpp.

104{ return m_vector.size(); }

◆ updateCC()

void Gaudi::ParticlePropertySvc::updateCC ( Gaudi::Details::PropertyBase & p )

the action in the case of interactive manipulation with properties: of the service

Parameters

p	the updated property

Definition at line 420 of file ParticlePropertySvc.cpp.

420{ m_ccMap.clear(); }

◆ updateDump()

void Gaudi::ParticlePropertySvc::updateDump ( Gaudi::Details::PropertyBase & p )

the action in the case of interactive manipulation with properties: of the service

Parameters

p	the updated property

Definition at line 426 of file ParticlePropertySvc.cpp.

                                                                     {
  if ( FSMState() < Gaudi::StateMachine::INITIALIZED ) { return; }
  dump();
}

◆ updateHandler()

void Gaudi::ParticlePropertySvc::updateHandler ( Gaudi::Details::PropertyBase & p )

the action in the case of interactive manipulation with properties:

no action if the internal data is not yet build
else rebuild the internal data Such action will allow more flexible interactive configuration of the service
Parameters

p the updated property

Definition at line 406 of file ParticlePropertySvc.cpp.

                                                                          {
  if ( FSMState() < Gaudi::StateMachine::INITIALIZED ) { return; }
 
  info() << "Property triggers the update of internal Particle Property Data : " << p << endmsg;
  // rebuild the internal data
  StatusCode sc = rebuild();
  if ( sc.isFailure() ) {
    throw GaudiException( "Can't rebuild Particle Properties Data", "*ParticlePropertySvc*", sc );
  }
  // clear CC-map
  m_ccMap.clear();
}

Member Data Documentation

◆ m_by_charge

NameSet Gaudi::ParticlePropertySvc::m_by_charge

Definition at line 279 of file ParticlePropertySvc.cpp.

◆ m_by_evtgen

NameSet Gaudi::ParticlePropertySvc::m_by_evtgen

Definition at line 283 of file ParticlePropertySvc.cpp.

◆ m_by_mass

NameSet Gaudi::ParticlePropertySvc::m_by_mass

Definition at line 280 of file ParticlePropertySvc.cpp.

◆ m_by_pythia

NameSet Gaudi::ParticlePropertySvc::m_by_pythia

Definition at line 284 of file ParticlePropertySvc.cpp.

◆ m_by_tlife

NameSet Gaudi::ParticlePropertySvc::m_by_tlife

Definition at line 281 of file ParticlePropertySvc.cpp.

◆ m_by_width

NameSet Gaudi::ParticlePropertySvc::m_by_width

Definition at line 282 of file ParticlePropertySvc.cpp.

◆ m_ccMap

Decays::CC::MapCC Gaudi::ParticlePropertySvc::m_ccMap

mutable

the CC-map

Definition at line 270 of file ParticlePropertySvc.cpp.

◆ m_ccmap_

Gaudi::Property<std::map<std::string, std::string> > Gaudi::ParticlePropertySvc::m_ccmap_

Initial value:

{
        this, "ChargeConjugations", Decays::Symbols::instance().cc(), &Gaudi::ParticlePropertySvc::updateCC,
        "The map of charge-conjugation & protected symbols" }

CC-map for properties.

Definition at line 272 of file ParticlePropertySvc.cpp.

                                                        {
        this, "ChargeConjugations", Decays::Symbols::instance().cc(), &Gaudi::ParticlePropertySvc::updateCC,
        "The map of charge-conjugation & protected symbols" };

◆ m_dump

Gaudi::Property<bool> Gaudi::ParticlePropertySvc::m_dump

Initial value:

{ this, "Dump", false, &Gaudi::ParticlePropertySvc::updateDump,

"Dump all properties in a table format" }

Gaudi::ParticlePropertySvc::updateDump

void updateDump(Gaudi::Details::PropertyBase &p)

the action in the case of interactive manipulation with properties: of the service

Definition ParticlePropertySvc.cpp:426

dump the table?

Definition at line 245 of file ParticlePropertySvc.cpp.

245 { this, "Dump", false, &Gaudi::ParticlePropertySvc::updateDump,

246 "Dump all properties in a table format" };

◆ m_filename

Gaudi::Property<std::string> Gaudi::ParticlePropertySvc::m_filename

Initial value:

{ this, "ParticlePropertiesFile", defaultFilename(),
                                             &Gaudi::ParticlePropertySvc::updateHandler,
                                             "The name of 'main' particle properties file" }

the main file with particle properties

Definition at line 253 of file ParticlePropertySvc.cpp.

                                       { this, "ParticlePropertiesFile", defaultFilename(),
                                             &Gaudi::ParticlePropertySvc::updateHandler,
                                             "The name of 'main' particle properties file" };

◆ m_modified

Vector Gaudi::ParticlePropertySvc::m_modified

Definition at line 290 of file ParticlePropertySvc.cpp.

◆ m_nameMap

NameMap Gaudi::ParticlePropertySvc::m_nameMap

Map: { "name" : "property" }.

Definition at line 241 of file ParticlePropertySvc.cpp.

◆ m_no_anti

NameSet Gaudi::ParticlePropertySvc::m_no_anti

Definition at line 288 of file ParticlePropertySvc.cpp.

◆ m_other

Gaudi::Property<Files> Gaudi::ParticlePropertySvc::m_other

Initial value:

{ this,
                                    "OtherFiles",
                                    {},
                                    &Gaudi::ParticlePropertySvc::updateHandler,
                                    "The (optional) list of additional files with the particle data" }

additional files

Definition at line 257 of file ParticlePropertySvc.cpp.

                                { this,
                                    "OtherFiles",
                                    {},
                                    &Gaudi::ParticlePropertySvc::updateHandler,
                                    "The (optional) list of additional files with the particle data" };

◆ m_particles

Gaudi::Property<Particles> Gaudi::ParticlePropertySvc::m_particles

Initial value:

{ this,
                                            "Particles",
                                            {},
                                            &Gaudi::ParticlePropertySvc::updateHandler,
                                            "The (optional) list of special particle properties" }

properties to be redefined explicitly

Definition at line 263 of file ParticlePropertySvc.cpp.

                                        { this,
                                            "Particles",
                                            {},
                                            &Gaudi::ParticlePropertySvc::updateHandler,
                                            "The (optional) list of special particle properties" };

◆ m_pidMap

PidMap Gaudi::ParticlePropertySvc::m_pidMap

Map: { "pid" : "property" }.

Definition at line 243 of file ParticlePropertySvc.cpp.

◆ m_replaced_names

NameSet Gaudi::ParticlePropertySvc::m_replaced_names

Definition at line 286 of file ParticlePropertySvc.cpp.

◆ m_replaced_pids

PidSet Gaudi::ParticlePropertySvc::m_replaced_pids

Definition at line 287 of file ParticlePropertySvc.cpp.

◆ m_set

Set Gaudi::ParticlePropertySvc::m_set

the actual storage of all particle properties

Definition at line 237 of file ParticlePropertySvc.cpp.

◆ m_vector

Vector Gaudi::ParticlePropertySvc::m_vector

"visible" data (the ordered container)

Definition at line 239 of file ParticlePropertySvc.cpp.

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

GaudiPartProp/src/Module/ParticlePropertySvc.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Files

◆ NameMap

◆ NameSet

◆ Particles

◆ PidMap

◆ PidSet

◆ Set

◆ Vector

Constructor & Destructor Documentation

◆ ParticlePropertySvc()

Member Function Documentation

◆ addParticle()

◆ begin()

◆ cc()

◆ diff()

◆ dump()

◆ end()

◆ find() [1/2]

◆ find() [2/2]

◆ initialize()

◆ parse()

◆ parseLine()

◆ rebuild()

◆ setAntiParticles()

◆ size()

◆ updateCC()

◆ updateDump()

◆ updateHandler()

Member Data Documentation

◆ m_by_charge

◆ m_by_evtgen

◆ m_by_mass

◆ m_by_pythia

◆ m_by_tlife

◆ m_by_width

◆ m_ccMap

◆ m_ccmap_

◆ m_dump

◆ m_filename

◆ m_modified

◆ m_nameMap

◆ m_no_anti

◆ m_other

◆ m_particles

◆ m_pidMap

◆ m_replaced_names

◆ m_replaced_pids

◆ m_set

◆ m_vector