#include <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, IJobOptionsSvc >
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	setMyProperties (const std::string &client, IProperty *me) override
	Override default properties of the calling client. More...

StatusCode	addPropertyToCatalogue (const std::string &client, const Gaudi::Details::PropertyBase &property) override
	Add a property into the JobOptions catalog. More...

StatusCode	removePropertyFromCatalogue (const std::string &client, const std::string &name) override
	Remove a property from the JobOptions catalog. More...

const std::vector< const Gaudi::Details::PropertyBase * > *	getProperties (const std::string &client) const override
	Get the properties associated to a given client. More...

const Gaudi::Details::PropertyBase *	getClientProperty (const std::string &client, const std::string &name) const override
	Get a property for a client. More...

std::vector< std::string >	getClients () const override
	Get the list of clients. More...

StatusCode	readOptions (const std::string &file, const std::string &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, IJobOptionsSvc >
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 ()
	Method for setting declared properties to the values specified for the job. 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 >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

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 Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

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

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

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

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

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

StatusCode	getProperty (const std::string &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 (const std::string &name) const override
	Return true if we have a property with the given name. More...

	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 Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

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

template<typename C >
void	dump (const std::string &file, const C &catalog) const
	dump properties catalog to file More...

Private Attributes
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"}

SvcCatalog	m_svc_catalog

Additional Inherited Members
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

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

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

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"}

Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, " 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()"}

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

Definition at line 31 of file JobOptionsSvc.h.

Member Typedef Documentation

◆ PropertiesT

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

Definition at line 33 of file JobOptionsSvc.h.

Constructor & Destructor Documentation

◆ JobOptionsSvc()

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

Definition at line 34 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" );
 }

Member Function Documentation

◆ addPropertyToCatalogue()

StatusCode JobOptionsSvc::addPropertyToCatalogue	(	const std::string &	client,
		const Gaudi::Details::PropertyBase &	property
	)

override

Add a property into the JobOptions catalog.

Definition at line 63 of file JobOptionsSvc.cpp.

                                                                                              {
   auto p = std::make_unique<Gaudi::Property<std::string>>( property.name(), "" );
   return property.load( *p ) ? m_svc_catalog.addProperty( client, p.release() ) : StatusCode::FAILURE;
 }

◆ dump()

template<typename C >

void JobOptionsSvc::dump	(	const std::string &	file,
		const C &	catalog
	)		const

private

dump properties catalog to file

Definition at line 98 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 109 of file JobOptionsSvc.cpp.

                                                                  {
   for ( const auto& client : catalog ) {
     for ( const auto& current : client.second ) {
       if ( auto sc = addPropertyToCatalogue(
                client.first, Gaudi::Property<std::string>{current.NameInClient(), current.ValueAsString()} );
            !sc )
         throw GaudiException( "Failed to fill the catalog", name(), sc );
     }
   }
 }

◆ getClientProperty()

const Gaudi::Details::PropertyBase* JobOptionsSvc::getClientProperty	(	const std::string &	client,
		const std::string &	name
	)		const

inlineoverride

Get a property for a client.

Definition at line 58 of file JobOptionsSvc.h.

                                                                                                 {
     return m_svc_catalog.getProperty( client, name );
   }

◆ getClients()

std::vector< std::string > JobOptionsSvc::getClients ( ) const

override

Get the list of clients.

Definition at line 95 of file JobOptionsSvc.cpp.

95 { return m_svc_catalog.getClients(); }

JobOptionsSvc::m_svc_catalog

SvcCatalog m_svc_catalog

Definition: JobOptionsSvc.h:88

SvcCatalog::getClients

std::vector< std::string > getClients() const

Definition: SvcCatalog.cpp:73

◆ getProperties()

const JobOptionsSvc::PropertiesT * JobOptionsSvc::getProperties ( const std::string & client ) const

override

Get the properties associated to a given client.

Definition at line 73 of file JobOptionsSvc.cpp.

                                                                                             {
   return m_svc_catalog.getProperties( client );
 }

◆ initialize()

StatusCode JobOptionsSvc::initialize ( )

override

Definition at line 39 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;
 }

◆ readOptions()

StatusCode JobOptionsSvc::readOptions	(	const std::string &	file,
		const std::string &	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 120 of file JobOptionsSvc.cpp.

                                                                                     {
   std::string search_path = 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;
 }

◆ removePropertyFromCatalogue()

StatusCode JobOptionsSvc::removePropertyFromCatalogue	(	const std::string &	client,
		const std::string &	name
	)

override

Remove a property from the JobOptions catalog.

Definition at line 69 of file JobOptionsSvc.cpp.

                                                                                                       {
   return m_svc_catalog.removeProperty( client, name );
 }

◆ setMyProperties()

StatusCode JobOptionsSvc::setMyProperties	(	const std::string &	client,
		IProperty *	me
	)

override

Override default properties of the calling client.

Parameters

client	Name of the client algorithm or service
me	Address of the interface IProperty of the client

Definition at line 77 of file JobOptionsSvc.cpp.

                                                                                      {
   const auto* props = m_svc_catalog.getProperties( client );
   if ( !props ) { return StatusCode::SUCCESS; }
 
   bool fail = false;
   for ( const auto& cur : *props ) {
     StatusCode sc = myInt->setProperty( *cur );
     if ( sc.isFailure() ) {
       error() << "Unable to set the property '" << cur->name() << "'"
               << " of '" << client << "'. "
               << "Check option and algorithm names, type and bounds." << endmsg;
       fail = true;
     }
   }
   return fail ? StatusCode::FAILURE : StatusCode::SUCCESS;
 }

◆ start()

StatusCode JobOptionsSvc::start ( )

override

Definition at line 57 of file JobOptionsSvc.cpp.

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

Member Data Documentation

◆ m_dir_search_path

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

private

Definition at line 83 of file JobOptionsSvc.h.

◆ m_dump

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

private

Definition at line 84 of file JobOptionsSvc.h.

◆ m_pythonAction

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

private

Definition at line 85 of file JobOptionsSvc.h.

◆ m_pythonParams

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

private

Definition at line 86 of file JobOptionsSvc.h.

◆ m_source_path

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

private

Definition at line 82 of file JobOptionsSvc.h.

◆ m_source_type

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

private

Definition at line 81 of file JobOptionsSvc.h.

◆ m_svc_catalog

SvcCatalog JobOptionsSvc::m_svc_catalog

private

Definition at line 88 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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertiesT

Constructor & Destructor Documentation

◆ JobOptionsSvc()

Member Function Documentation

◆ addPropertyToCatalogue()

◆ dump()

◆ fillServiceCatalog()

◆ getClientProperty()

◆ getClients()

◆ getProperties()

◆ initialize()

◆ readOptions()

◆ removePropertyFromCatalogue()

◆ setMyProperties()

◆ start()

Member Data Documentation

◆ m_dir_search_path

◆ m_dump

◆ m_pythonAction

◆ m_pythonParams

◆ m_source_path

◆ m_source_type

◆ m_svc_catalog