#include </builds/gaudi/Gaudi/GaudiCoreSvc/src/JobOptionsSvc/JobOptionsSvc.h>

Inheritance diagram for JobOptionsSvc:

[legend]

Collaboration diagram for JobOptionsSvc:

[legend]

Public Types
typedef std::vector< const Gaudi::Details::PropertyBase * >	PropertiesT

Public Types inherited from extends< Service, Gaudi::Interfaces::IOptionsSvc >
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...

Public Member Functions
	JobOptionsSvc (const std::string &name, ISvcLocator *svc)

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	readOptions (std::string_view file, std::string_view path="") override
	look for file 'file' into search path 'path' and read it to update existing JobOptionsCatalogue More...

Public Member Functions inherited from extends< Service, Gaudi::Interfaces::IOptionsSvc >
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...

StatusCode	setProperties ()

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

Protected Member Functions

void	set (const std::string &key, const std::string &value) override

std::string	get (const std::string &key, const std::string &default_={}) const override

std::string	pop (const std::string &key, const std::string &default_={}) override

bool	has (const std::string &key) const override

std::vector< std::tuple< std::string, std::string > >	items () const override

bool	isSet (const std::string &key) const override

void	bind (const std::string &prefix, Gaudi::Details::PropertyBase *property) override

void	broadcast (const std::regex &filter, const std::string &value, OnlyDefaults defaults_only) override

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

Private Types
using	StorageType = std::unordered_map< std::string, Gaudi::Details::WeakPropertyRef >

Private Member Functions
void	fillServiceCatalog (const Gaudi::Parsers::Catalog &catalog)

void	dump (const std::string &file, const Gaudi::Parsers::Catalog &catalog) const
	dump properties catalog to file More...

void	dump (const std::string &file) const

Private Attributes
StorageType	m_options

std::map< std::string, std::unique_ptr< Gaudi::Details::PropertyBase > >	m_old_iface_compat

std::map< std::string, PropertiesT >	m_old_iface_compat_2

Gaudi::Property< std::string >	m_source_type {this, "TYPE"}

Gaudi::Property< std::string >	m_source_path {this, "PATH"}

Gaudi::Property< std::string >	m_dir_search_path {this, "SEARCHPATH"}

Gaudi::Property< std::string >	m_dump {this, "DUMPFILE"}

Gaudi::Property< std::string >	m_pythonAction {this, "PYTHONACTION"}

Gaudi::Property< std::string >	m_pythonParams {this, "PYTHONPARAMS"}

Gaudi::Property< std::vector< std::pair< std::string, std::string > > >	m_globalDefaultsProp

Gaudi::Property< bool >	m_reportUnused {this, "ReportUnused", false, "Print report of properties set, but not used"}

std::vector< std::pair< std::regex, std::string > >	m_globalDefaults

Additional Inherited Members
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 {this, "AutoRetrieveTools", true, "retrieve all AlgTools during initialize"}

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition at line 30 of file JobOptionsSvc.h.

Member Typedef Documentation

◆ PropertiesT

typedef std::vector<const Gaudi::Details::PropertyBase*> JobOptionsSvc::PropertiesT

Definition at line 32 of file JobOptionsSvc.h.

◆ StorageType

using JobOptionsSvc::StorageType = std::unordered_map<std::string, Gaudi::Details::WeakPropertyRef>

private

Definition at line 35 of file JobOptionsSvc.h.

Constructor & Destructor Documentation

◆ JobOptionsSvc()

JobOptionsSvc::JobOptionsSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 61 of file JobOptionsSvc.cpp.

                                                                       : base_class( name, svc ) {
   if ( System::isEnvSet( "JOBOPTSEARCHPATH" ) ) m_dir_search_path = System::getEnv( "JOBOPTSEARCHPATH" );
   if ( System::isEnvSet( "JOBOPTSDUMPFILE" ) ) m_dump = System::getEnv( "JOBOPTSDUMPFILE" );
  
   m_globalDefaultsProp.declareUpdateHandler( [this]( Gaudi::Details::PropertyBase& ) {
     m_globalDefaults.clear();
     m_globalDefaults.reserve( m_globalDefaultsProp.size() );
     for ( const auto& p : m_globalDefaultsProp ) { m_globalDefaults.emplace_back( p.first, p.second ); }
   } );
 }

Member Function Documentation

◆ bind()

void JobOptionsSvc::bind	(	const std::string &	prefix,
		Gaudi::Details::PropertyBase *	property
	)

overrideprotected

Definition at line 176 of file JobOptionsSvc.cpp.

                                                                                       {
   const std::string key = prefix + '.' + property->name();
  
   std::tuple<bool, std::string_view> defaultValue{false, ""};
   if ( !has( key ) && !m_globalDefaults.empty() ) { // look for a global default only if it was not set
     std::smatch match;
     for ( const auto& p : m_globalDefaults ) {
       if ( regex_match( key, match, p.first ) ) { defaultValue = {true, p.second}; }
     }
   }
  
   m_options[key] = *property;
  
   // at this point the property is bound, so we can set the default if needed
   if ( std::get<0>( defaultValue ) ) set( key, std::string{std::get<1>( defaultValue )} );
 }

◆ broadcast()

void JobOptionsSvc::broadcast	(	const std::regex &	filter,
		const std::string &	value,
		OnlyDefaults	defaults_only
	)

overrideprotected

Definition at line 193 of file JobOptionsSvc.cpp.

                                                                                                           {
   std::smatch match;
   for ( auto& p : m_options ) {
     if ( !defaults_only || !p.second.isSet() ) {
       if ( regex_match( p.first, match, filter ) ) { p.second = value; }
     }
   }
 }

◆ dump() [1/2]

void JobOptionsSvc::dump ( const std::string & file ) const

private

Definition at line 125 of file JobOptionsSvc.cpp.

                                                       {
   std::ofstream out( file, std::ios_base::out | std::ios_base::trunc );
   if ( !out ) {
     error() << "Unable to open dump-file \"" + file + "\"" << endmsg;
   } else {
     info() << "Properties are dumped into \"" + file + "\"" << endmsg;
     for ( const auto& [key, value] : items() ) {
       out << key << " = " << value << ';';
       if ( !m_options.find( key )->second.isBound() ) out << " // unused";
       out << '\n';
     }
   }
 }

◆ dump() [2/2]

void JobOptionsSvc::dump	(	const std::string &	file,
		const Gaudi::Parsers::Catalog &	catalog
	)		const

private

dump properties catalog to file

Definition at line 114 of file JobOptionsSvc.cpp.

                                                                                 {
   std::ofstream out( file, std::ios_base::out | std::ios_base::trunc );
   if ( !out ) {
     error() << "Unable to open dump-file \"" + file + "\"" << endmsg;
     return; // RETURN
   }
   info() << "Properties are dumped into \"" + file + "\"" << endmsg;
   // perform the actual dump:
   out << catalog;
 }

◆ fillServiceCatalog()

void JobOptionsSvc::fillServiceCatalog ( const Gaudi::Parsers::Catalog & catalog )

private

Definition at line 139 of file JobOptionsSvc.cpp.

                                                                  {
   for ( const auto& client : catalog ) {
     for ( const auto& current : client.second ) {
       set( client.first + '.' + current.NameInClient(), current.ValueAsString() );
     }
   }
 }

◆ get()

std::string JobOptionsSvc::get	(	const std::string &	key,
		const std::string &	default_ = `{}`
	)		const

inlineoverrideprotected

Definition at line 45 of file JobOptionsSvc.h.

                                                                    {} ) const override {
     auto item = m_options.find( key );
     return item != m_options.end() ? std::string{item->second} : default_;
   }

◆ has()

bool JobOptionsSvc::has ( const std::string & key ) const

inlineoverrideprotected

Definition at line 59 of file JobOptionsSvc.h.

59 { return m_options.find( key ) != m_options.end(); }

◆ initialize()

StatusCode JobOptionsSvc::initialize ( )

override

Definition at line 72 of file JobOptionsSvc.cpp.

                                      {
   // Call base class initializer
   StatusCode sc = Service::initialize();
   // Read the job options if needed
   if ( sc ) {
     if ( m_source_type == "NONE" ) {
       return sc;
     } else if ( m_source_type == "PYTHON" ) {
       PythonConfig conf( this );
       return conf.evaluateConfig( m_source_path, m_pythonParams, m_pythonAction );
     } else {
       return readOptions( m_source_path, m_dir_search_path );
     }
   }
   return sc;
 }

◆ isSet()

bool JobOptionsSvc::isSet ( const std::string & key ) const

inlineoverrideprotected

Definition at line 67 of file JobOptionsSvc.h.

                                                     {
     auto item = m_options.find( key );
     return item != m_options.end() && item->second.isSet();
   }

◆ items()

std::vector<std::tuple<std::string, std::string> > JobOptionsSvc::items ( ) const

inlineoverrideprotected

Definition at line 60 of file JobOptionsSvc.h.

                                                                    {
     std::vector<std::tuple<std::string, std::string>> v;
     v.reserve( m_options.size() );
     std::for_each( begin( m_options ), end( m_options ), [&v]( const auto& item ) { v.emplace_back( item ); } );
     std::sort( begin( v ), end( v ) );
     return v;
   }

◆ pop()

std::string JobOptionsSvc::pop	(	const std::string &	key,
		const std::string &	default_ = `{}`
	)

inlineoverrideprotected

Definition at line 49 of file JobOptionsSvc.h.

                                                                    {} ) override {
     std::string result = default_;
  
     auto item = m_options.find( key );
     if ( item != m_options.end() ) {
       result = std::move( item->second );
       m_options.erase( item );
     }
     return result;
   }

◆ readOptions()

StatusCode JobOptionsSvc::readOptions	(	std::string_view	file,
		std::string_view	path = `""`
	)

override

look for file 'file' into search path 'path' and read it to update existing JobOptionsCatalogue

Parameters

file	file name
path	search path

Returns: status code

Definition at line 147 of file JobOptionsSvc.cpp.

                                                                                 {
   std::string search_path = std::string{path};
   if ( search_path.empty() && !m_dir_search_path.empty() ) { search_path = m_dir_search_path; }
   //
   if ( msgLevel( MSG::DEBUG ) )
     debug() << "Reading options from the file "
             << "'" << file << "'" << endmsg;
   gp::Messages      messages( msgStream() );
   gp::Catalog       catalog;
   gp::Units         units;
   gp::PragmaOptions pragma;
   gp::Node          ast;
   StatusCode        sc = gp::ReadOptions( file, path, &messages, &catalog, &units, &pragma, &ast ) ? StatusCode::SUCCESS
                                                                                             : StatusCode::FAILURE;
  
   // --------------------------------------------------------------------------
   if ( sc.isSuccess() ) {
     if ( pragma.IsPrintOptions() ) { info() << "Print options" << std::endl << catalog << endmsg; }
     if ( pragma.IsPrintTree() ) { info() << "Print tree:" << std::endl << ast.ToString() << endmsg; }
     if ( pragma.HasDumpFile() ) dump( pragma.dumpFile(), catalog );
     info() << "Job options successfully read in from " << file << endmsg;
     fillServiceCatalog( catalog );
   } else {
     fatal() << "Job options errors." << endmsg;
   }
   // ----------------------------------------------------------------------------
   return sc;
 }

◆ set()

void JobOptionsSvc::set	(	const std::string &	key,
		const std::string &	value
	)

inlineoverrideprotected

Definition at line 44 of file JobOptionsSvc.h.

44 { m_options[key] = value; }

◆ start()

StatusCode JobOptionsSvc::start ( )

override

Definition at line 109 of file JobOptionsSvc.cpp.

                                 {
   if ( !m_dump.empty() ) { dump( m_dump ); }
   return StatusCode::SUCCESS;
 }

◆ stop()

StatusCode JobOptionsSvc::stop ( )

override

Definition at line 88 of file JobOptionsSvc.cpp.

                                {
   if ( m_reportUnused ) {
     std::vector<std::string_view> unused;
     unused.reserve( m_options.size() );
  
     for ( const auto& p : m_options ) {
       if ( !p.second.isBound() ) unused.emplace_back( p.first );
     }
  
     if ( !unused.empty() ) {
       std::sort( unused.begin(), unused.end() );
       auto& log = warning();
       log << unused.size() << " unused properties:";
       for ( const auto& k : unused ) log << "\n - " << k;
       log << endmsg;
     }
   }
   return Service::stop();
 }

Member Data Documentation

◆ m_dir_search_path

Gaudi::Property<std::string> JobOptionsSvc::m_dir_search_path {this, "SEARCHPATH"}

private

Definition at line 103 of file JobOptionsSvc.h.

◆ m_dump

Gaudi::Property<std::string> JobOptionsSvc::m_dump {this, "DUMPFILE"}

private

Definition at line 104 of file JobOptionsSvc.h.

◆ m_globalDefaults

std::vector<std::pair<std::regex, std::string> > JobOptionsSvc::m_globalDefaults

private

Definition at line 113 of file JobOptionsSvc.h.

◆ m_globalDefaultsProp

Gaudi::Property<std::vector<std::pair<std::string, std::string> > > JobOptionsSvc::m_globalDefaultsProp

private

Initial value:

{

this, "GlobalDefaults", {}, "Allow definition of global defaults for properties as list of pairs (regex, value)"}

Definition at line 108 of file JobOptionsSvc.h.

◆ m_old_iface_compat

std::map<std::string, std::unique_ptr<Gaudi::Details::PropertyBase> > JobOptionsSvc::m_old_iface_compat

mutableprivate

Definition at line 39 of file JobOptionsSvc.h.

◆ m_old_iface_compat_2

std::map<std::string, PropertiesT> JobOptionsSvc::m_old_iface_compat_2

mutableprivate

Definition at line 40 of file JobOptionsSvc.h.

◆ m_options

StorageType JobOptionsSvc::m_options

private

Definition at line 37 of file JobOptionsSvc.h.

◆ m_pythonAction

Gaudi::Property<std::string> JobOptionsSvc::m_pythonAction {this, "PYTHONACTION"}

private

Definition at line 105 of file JobOptionsSvc.h.

◆ m_pythonParams

Gaudi::Property<std::string> JobOptionsSvc::m_pythonParams {this, "PYTHONPARAMS"}

private

Definition at line 106 of file JobOptionsSvc.h.

◆ m_reportUnused

Gaudi::Property<bool> JobOptionsSvc::m_reportUnused {this, "ReportUnused", false, "Print report of properties set, but not used"}

private

Definition at line 111 of file JobOptionsSvc.h.

◆ m_source_path

Gaudi::Property<std::string> JobOptionsSvc::m_source_path {this, "PATH"}

private

Definition at line 102 of file JobOptionsSvc.h.

◆ m_source_type

Gaudi::Property<std::string> JobOptionsSvc::m_source_type {this, "TYPE"}

private

Definition at line 101 of file JobOptionsSvc.h.

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

GaudiCoreSvc/src/JobOptionsSvc/JobOptionsSvc.h
GaudiCoreSvc/src/JobOptionsSvc/JobOptionsSvc.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertiesT

◆ StorageType

Constructor & Destructor Documentation

◆ JobOptionsSvc()

Member Function Documentation

◆ bind()

◆ broadcast()

◆ dump() [1/2]

◆ dump() [2/2]

◆ fillServiceCatalog()

◆ get()

◆ has()

◆ initialize()

◆ isSet()

◆ items()

◆ pop()

◆ readOptions()

◆ set()

◆ start()

◆ stop()

Member Data Documentation

◆ m_dir_search_path

◆ m_dump

◆ m_globalDefaults

◆ m_globalDefaultsProp

◆ m_old_iface_compat

◆ m_old_iface_compat_2

◆ m_options

◆ m_pythonAction

◆ m_pythonParams

◆ m_reportUnused

◆ m_source_path

◆ m_source_type