#include <src/JobOptionsSvc/JobOptionsSvc.h>

Inheritance diagram for JobOptionsSvc:

Collaboration diagram for JobOptionsSvc:

Public Types
typedef std::vector< const Property * >	PropertiesT

Public Types inherited from extends< Service, IProperty, 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
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

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)

	~JobOptionsSvc () override=default
	destructor More...

StatusCode	initialize () 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 Property &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 Property * > *	getProperties (const std::string &client) const override
	Get the properties associated to a given 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...

StatusCode	setProperty (const Property &p) override
	IProperty implementation (needed for initialisation) More...

StatusCode	getProperty (Property *p) const override

Public Member Functions inherited from extends< Service, IProperty, 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...

	~extends () override=default
	Virtual destructor. 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...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public 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 CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

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

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

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

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

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

Private Attributes
PropertyMgr	m_pmgr
	dump the content of Properties catalog to the predefined file More...

std::string	m_source_path

std::string	m_source_type

std::string	m_dir_search_path

std::string	m_dump

std::string	m_pythonAction

std::string	m_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 CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

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

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

Detailed Description

Definition at line 20 of file JobOptionsSvc.h.

Member Typedef Documentation

typedef std::vector<const Property*> JobOptionsSvc::PropertiesT

Definition at line 24 of file JobOptionsSvc.h.

Constructor & Destructor Documentation

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

Definition at line 27 of file JobOptionsSvc.cpp.

                                                                   :
   base_class(name,svc)
 {
   m_pmgr.addRef(); // make sure the refCount doesn't go to zero too soon...
   std::string tmp ;
   tmp = System::getEnv ( "JOBOPTSEARCHPATH" ) ;
   if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dir_search_path = tmp ; }
   tmp = System::getEnv ( "JOBOPTSDUMPFILE"  ) ;
   if ( !tmp.empty() && ("UNKNOWN" != tmp) ) { m_dump = tmp ; }
 
   m_pmgr.declareProperty( "TYPE"       , m_source_type   ) ;
   m_pmgr.declareProperty( "PATH"       , m_source_path   ) ;
   m_pmgr.declareProperty( "SEARCHPATH" , m_dir_search_path ) ;
   m_pmgr.declareProperty( "DUMPFILE"   , m_dump          ) ;
   m_pmgr.declareProperty( "PYTHONACTION" , m_pythonAction  ) ;
   m_pmgr.declareProperty( "PYTHONPARAMS" , m_pythonParams  ) ;
 }

JobOptionsSvc::~JobOptionsSvc ( )

overridedefault

destructor

Member Function Documentation

StatusCode JobOptionsSvc::addPropertyToCatalogue	(	const std::string &	client,
		const Property &	property
	)

override

Add a property into the JobOptions catalog.

Definition at line 75 of file JobOptionsSvc.cpp.

 {
   std::unique_ptr<Property> p { new StringProperty ( property.name(), "" ) } ;
   return property.load( *p ) ? m_svc_catalog.addProperty( client , p.release() )
                              : StatusCode::FAILURE ;
 }

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

private

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

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

private

Definition at line 138 of file JobOptionsSvc.cpp.

                                                                {
   for (const auto&  client : catalog) {
     for (const auto& current : client.second ) {
       addPropertyToCatalogue ( client.first ,
                                StringProperty{ current.NameInClient(),
                                                current.ValueAsString() } );
     }
   }
 }

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

override

Get the list of clients.

Definition at line 121 of file JobOptionsSvc.cpp.

                                                      {
   return m_svc_catalog.getClients();
 }

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

override

Get the properties associated to a given client.

Definition at line 92 of file JobOptionsSvc.cpp.

 {
   return m_svc_catalog.getProperties(client);
 }

StatusCode JobOptionsSvc::getProperty ( Property * p ) const

override

Definition at line 50 of file JobOptionsSvc.cpp.

 {
   return m_pmgr.getProperty( p );
 }

StatusCode JobOptionsSvc::initialize ( )

override

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

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 148 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);
 
     // --------------------------------------------------------------------------
     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;
 }

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

override

Remove a property from the JobOptions catalog.

Definition at line 85 of file JobOptionsSvc.cpp.

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

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 97 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 ;
 }

StatusCode JobOptionsSvc::setProperty ( const Property & p )

override

IProperty implementation (needed for initialisation)

Definition at line 45 of file JobOptionsSvc.cpp.

 {
   return m_pmgr.setProperty( p );
 }

Member Data Documentation

std::string JobOptionsSvc::m_dir_search_path

private

Definition at line 78 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_dump

private

Definition at line 79 of file JobOptionsSvc.h.

PropertyMgr JobOptionsSvc::m_pmgr

private

dump the content of Properties catalog to the predefined file

Definition at line 75 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_pythonAction

private

Definition at line 80 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_pythonParams

private

Definition at line 81 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_path

private

Definition at line 76 of file JobOptionsSvc.h.

std::string JobOptionsSvc::m_source_type

private

Definition at line 77 of file JobOptionsSvc.h.

SvcCatalog JobOptionsSvc::m_svc_catalog

private

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation