#include </builds/gaudi/Gaudi/PartPropSvc/src/PartPropSvc.h>

Inheritance diagram for PartPropSvc:

[legend]

Collaboration diagram for PartPropSvc:

[legend]

Public Member Functions
StatusCode	initialize () override

StatusCode	finalize () override

HepPDT::ParticleDataTable *	PDT () override

void	setUnknownParticleHandler (HepPDT::ProcessUnknownID *, const std::string &) override

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

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

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

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

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 More...

StatusCode	sysStart () override
	Initialize Service More...

StatusCode	sysStop () override
	Initialize Service More...

StatusCode	sysFinalize () override
	Finalize Service More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

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

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

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

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

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

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, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

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. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

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

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. More...

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. More...

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

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

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

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

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

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

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

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

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

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

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

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

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

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) More...

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

Public Attributes
	InputFile

Private Types
using	inputFunPtr = bool(*)(std::istream &, HepPDT::TableBuilder &)

Private Member Functions
StatusCode	createTable ()

inputFunPtr	parseTableType (const std::string &)

Private Attributes
std::vector< std::pair< std::string, inputFunPtr > >	m_inputs

Gaudi::Property< std::string >	m_pdtFiles { this, "InputFile", "PDGTABLE.MeV" }

HepPDT::ProcessUnknownID *	m_upid = nullptr

std::string	m_upid_name

std::optional< HepPDT::ParticleDataTable >	m_pdt

bool	m_upid_local = false

Additional Inherited Members
Public Types inherited from extends< Service, IPartPropSvc >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

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 = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

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

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

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

	~Service () override
	Standard Destructor More...

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

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

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

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

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

Gaudi::Property< bool >	m_auditInit { this, "AuditServices", false, "[[deprecated]] unused" }

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 More...

Detailed Description

Definition at line 38 of file PartPropSvc.h.

Member Typedef Documentation

◆ inputFunPtr

using PartPropSvc::inputFunPtr = bool ( * )( std::istream&, HepPDT::TableBuilder& )

private

Definition at line 51 of file PartPropSvc.h.

Member Function Documentation

◆ createTable()

StatusCode PartPropSvc::createTable ( )

private

Definition at line 135 of file PartPropSvc.cpp.

                                     {
  
   // use a handler for unknown heavy ions
   if ( !m_upid ) {
     setUnknownParticleHandler( new HepPDT::HeavyIonUnknownID, "Default Heavy Ion Handler" );
     m_upid_local = true;
   }
  
   m_pdt.emplace( m_upid_name, m_upid );
  
   HepPDT::TableBuilder tb( *m_pdt );
  
   for ( const auto& itr : m_inputs ) {
     const auto& f  = itr.first;
     const auto& pF = itr.second;
  
     debug() << "Reading PDT file \"" << f << "\"" << endmsg;
  
     std::ifstream pdfile{ f };
     // build a table from the file
     if ( !pF( pdfile, tb ) ) {
       error() << "Error reading PDT file: \"" << f << "\"" << endmsg;
       return StatusCode::FAILURE;
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ finalize()

StatusCode PartPropSvc::finalize ( )

override

Definition at line 98 of file PartPropSvc.cpp.

                                  {
  
   m_pdt.reset();
  
   if ( m_upid_local && m_upid ) {
     m_upid_local = false;
     // This will cause a memory leak, but we can't delete it as the
     // destructor of HepPDT::processUnknownID is protected.
     // We need this though to call reinitialize successfully.
     m_upid = nullptr;
   }
  
   StatusCode status = Service::finalize();
  
   if ( status.isSuccess() ) { debug() << "Service finalised successfully" << endmsg; }
  
   return status;
 }

◆ initialize()

StatusCode PartPropSvc::initialize ( )

override

Definition at line 32 of file PartPropSvc.cpp.

                                    {
  
   StatusCode status = Service::initialize();
  
   if ( status.isFailure() ) {
     error() << "Could not initialize main svc" << endmsg;
     return StatusCode::FAILURE;
   }
  
   std::string key = m_pdtFiles.value();
  
   typedef boost::tokenizer<boost::char_separator<char>> tokenizer;
   boost::char_separator<char>                           sep( ", " );
   boost::char_separator<char>                           sep_eq( "=" );
  
   tokenizer tokens( key, sep );
   for ( auto it = tokens.begin(); it != tokens.end(); ++it ) {
  
     tokenizer tok2( *it, sep_eq );
     int       nToks( std::distance( tok2.begin(), tok2.end() ) );
  
     auto              it2   = tok2.begin();
     const std::string fname = *it2;
     std::string       fmt;
     if ( nToks == 1 ) {
       info() << "No table format type specified for \"" << fname << "\". Assuming PDG" << endmsg;
       fmt = "PDG";
     } else {
       ++it2;
       fmt = *it2;
     }
  
     // see if input file exists in $DATAPATH
     std::string rfile = System::PathResolver::find_file( fname, "DATAPATH" );
     if ( rfile.empty() ) {
       error() << "Could not find PDT file: \"" << fname << "\" in $DATAPATH" << endmsg;
       return StatusCode::FAILURE;
     }
  
     // is the file readable?
     std::ifstream pdfile{ rfile };
     if ( !pdfile ) {
       error() << "Could not open PDT file: \"" << rfile << "\"" << endmsg;
       return StatusCode::FAILURE;
     }
  
     std::string FMT = boost::algorithm::to_upper_copy( fmt );
  
     inputFunPtr pF = nullptr;
     try {
       pF = parseTableType( FMT );
     } catch ( ... ) {
       error() << "Could not determine Particle Property table type: \"" << FMT << "\" for file \"" << fname << "\""
               << endmsg;
       return StatusCode::FAILURE;
     }
  
     debug() << "Adding PDT file \"" << rfile << "\" type " << FMT << endmsg;
  
     m_inputs.emplace_back( rfile, pF );
   }
  
   return status;
 }

◆ parseTableType()

PartPropSvc::inputFunPtr PartPropSvc::parseTableType ( const std::string & typ )

private

Definition at line 119 of file PartPropSvc.cpp.

                                                                          {
   static const auto table = {
       std::make_pair( "PDG", &HepPDT::addPDGParticles ),       std::make_pair( "PYTHIA", &HepPDT::addPythiaParticles ),
       std::make_pair( "EVTGEN", &HepPDT::addEvtGenParticles ), std::make_pair( "HERWIG", &HepPDT::addHerwigParticles ),
       std::make_pair( "ISAJET", &HepPDT::addIsajetParticles ), std::make_pair( "QQ", &HepPDT::addQQParticles ) };
   auto i = std::find_if( std::begin( table ), std::end( table ),
                          [&]( const std::pair<const char*, inputFunPtr>& p ) { return typ == p.first; } );
   if ( i == std::end( table ) ) {
     error() << "Unknown Particle Data file type: \"" << typ << "\"" << endmsg;
     throw std::runtime_error( "error parsing particle table type" );
   }
   return i->second;
 }

◆ PDT()

HepPDT::ParticleDataTable * PartPropSvc::PDT ( )

override

Definition at line 166 of file PartPropSvc.cpp.

                                           {
  
   if ( !m_pdt ) {
     debug() << "creating ParticleDataTable" << endmsg;
     if ( createTable().isFailure() ) {
       fatal() << "Could not create ParticleDataTable" << endmsg;
       m_pdt.reset();
     }
   }
  
   return m_pdt ? &m_pdt.value() : nullptr;
 }

◆ setUnknownParticleHandler()

void PartPropSvc::setUnknownParticleHandler	(	HepPDT::ProcessUnknownID *	puid,
		const std::string &	n
	)

override

Definition at line 181 of file PartPropSvc.cpp.

                                                                                               {
   if ( m_pdt ) {
     error() << "not setting Unknown Particle Handler \"" << n << "\" as ParticleDataTable already instantiated"
             << endmsg;
     return;
   }
  
   debug() << "setting Unknown Particle Handler \"" << n << "\" at " << puid << endmsg;
  
   if ( m_upid ) {
     warning() << "overriding previously selected Unknown Particle Handler \"" << m_upid_name << "\" with \"" << n
               << "\"" << endmsg;
   }
  
   m_upid      = puid;
   m_upid_name = n;
 }

Member Data Documentation

◆ InputFile

PartPropSvc.InputFile

Definition at line 17 of file PartPropSvc.py.

◆ m_inputs

std::vector<std::pair<std::string, inputFunPtr> > PartPropSvc::m_inputs

private

Definition at line 54 of file PartPropSvc.h.

◆ m_pdt

std::optional<HepPDT::ParticleDataTable> PartPropSvc::m_pdt

private

Definition at line 61 of file PartPropSvc.h.

◆ m_pdtFiles

Gaudi::Property<std::string> PartPropSvc::m_pdtFiles { this, "InputFile", "PDGTABLE.MeV" }

private

Definition at line 56 of file PartPropSvc.h.

◆ m_upid

HepPDT::ProcessUnknownID* PartPropSvc::m_upid = nullptr

private

Definition at line 58 of file PartPropSvc.h.

◆ m_upid_local

bool PartPropSvc::m_upid_local = false

private

Definition at line 65 of file PartPropSvc.h.

◆ m_upid_name

std::string PartPropSvc::m_upid_name

private

Definition at line 59 of file PartPropSvc.h.

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

PartPropSvc/src/PartPropSvc.h
PartPropSvc/share/PartPropSvc.py
PartPropSvc/src/PartPropSvc.cpp

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ inputFunPtr

Member Function Documentation

◆ createTable()

◆ finalize()

◆ initialize()

◆ parseTableType()

◆ PDT()

◆ setUnknownParticleHandler()

Member Data Documentation

◆ InputFile

◆ m_inputs

◆ m_pdt

◆ m_pdtFiles

◆ m_upid

◆ m_upid_local

◆ m_upid_name