Base class for all services. More...

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Service.h>

Inheritance diagram for Service:

[legend]

Collaboration diagram for Service:

[legend]

Public Types
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

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

using	base_class = CommonMessaging

Public Member Functions
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...

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 CommonMessaging< implements3< IService, IProperty, IStateful > >
	~CommonMessaging () override=default
	Virtual destructor. More...

	~CommonMessaging () override=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. 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 &	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 &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

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

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

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

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

MsgStream &	error () 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 &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

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

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

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

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

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

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

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) 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...

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

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

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

Protected Member Functions
	~Service () override
	Standard Destructor. More...

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

	~Service () override
	Standard Destructor. More...

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

Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

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

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

Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...

std::unique_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...

bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message service. More...

Private Member Functions
void	setServiceManager (ISvcManager *ism) override

void	initOutputLevel (Property &prop)
	callback for output level property More...

void	setServiceManager (ISvcManager *ism) override

void	initOutputLevel (Property &prop)
	callback for output level property More...

Private Attributes
std::string	m_name
	Service Name. More...

SmartIF< ISvcLocator >	m_svcLocator
	Service Locator reference. More...

SmartIF< ISvcManager >	m_svcManager

SmartIF< PropertyMgr >	m_propertyMgr
	Property Manager. More...

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

BooleanProperty	m_auditInit

bool	m_auditorInitialize

bool	m_auditorStart

bool	m_auditorStop

bool	m_auditorFinalize

bool	m_auditorReinitialize

bool	m_auditorRestart

Friends
class	ServiceManager

Detailed Description

Base class for all services.

It implements the IService and IProperty interfaces.

Author: Pere Mato; Marco Clemencic

Definition at line 35 of file Service.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory<IService*, const std::string&, ISvcLocator*> Service::Factory

Definition at line 40 of file Service.h.

typedef Gaudi::PluginService::Factory<IService*, const std::string&, ISvcLocator*> Service::Factory

Definition at line 40 of file Service.h.

Constructor & Destructor Documentation

Service::Service	(	std::string	name,
		ISvcLocator *	svcloc
	)

Standard Constructor.

Definition at line 386 of file Service.cpp.

                                                     :
   m_name( std::move(name) ),
   m_svcLocator(  svcloc ),
   m_propertyMgr(  new PropertyMgr() )
 {
   // Declare common Service properties with their defaults
   if ( (name != "MessageSvc") && msgSvc() )  {
     // In genconf a service is instantiated without the ApplicationMgr
     m_outputLevel = msgSvc()->outputLevel();
   }
   declareProperty("OutputLevel", m_outputLevel);
   m_outputLevel.declareUpdateHandler(&Service::initOutputLevel, this);
 
   // Get the default setting for service auditing from the AppMgr
   declareProperty("AuditServices", m_auditInit = true);
 
   bool audit(false);
   auto appMgr = serviceLocator()->service<IProperty>("ApplicationMgr");
   if (appMgr) {
     const Property& prop = appMgr->getProperty("AuditServices");
     if (m_name != "IncidentSvc") {
       setProperty(prop).ignore();
       audit = m_auditInit.value();
     } else {
       audit = false;
     }
   }
 
   declareProperty( "AuditInitialize"   , m_auditorInitialize   = audit );
   declareProperty( "AuditStart"        , m_auditorStart        = audit );
   declareProperty( "AuditStop"         , m_auditorStop         = audit );
   declareProperty( "AuditFinalize"     , m_auditorFinalize     = audit );
   declareProperty( "AuditReInitialize" , m_auditorReinitialize = audit );
   declareProperty( "AuditReStart"      , m_auditorRestart      = audit );
 }

Service::~Service ( )

overrideprotected

Standard Destructor.

Definition at line 21 of file Service.cpp.

                   {
     if (m_svcManager) m_svcManager->removeService(this).ignore();
 }

Service::Service	(	std::string	name,
		ISvcLocator *	svcloc
	)

Standard Constructor.

Service::~Service ( )

overrideprotected

Standard Destructor.

Member Function Documentation

SmartIF< IAuditorSvc > & Service::auditorSvc ( ) const

The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Definition at line 431 of file Service.cpp.

                                                 {
   if ( !m_pAuditorSvc ) {
     m_pAuditorSvc = serviceLocator()->service("AuditorSvc");
     if( !m_pAuditorSvc ) {
       throw GaudiException("Service [AuditorSvc] not found", name(), StatusCode::FAILURE);
     }
   }
   return m_pAuditorSvc;
 }

SmartIF<IAuditorSvc>& Service::auditorSvc ( ) const

The standard auditor service.May not be invoked before sysInitialize() has been invoked.

StatusCode Service::configure ( )

inlineoverride

Definition at line 48 of file Service.h.

48 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

StatusCode Service::configure ( )

inlineoverride

Definition at line 48 of file Service.h.

48 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

template<class T >

StatusCode Service::declarePrivateTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Private tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 243 of file Service.h.

                                       {
 
         if (toolTypeAndName == "")
             toolTypeAndName = System::typeinfoName(typeid(T));
 
         StatusCode sc = handle.initialize(toolTypeAndName, this, createIf);
 
         MsgStream log(msgSvc(), name());
 
         if (sc.isSuccess()) {
             log << MSG::DEBUG << "Handle for private tool" << toolTypeAndName
                     << " successfully created and stored." << endmsg;
         } else {
 
             log << MSG::ERROR << "Handle for private tool" << toolTypeAndName
                     << " could not be created." << endmsg;
         }
 
         return sc;
 
     }

template<class T >

StatusCode Service::declarePrivateTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Private tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 243 of file Service.h.

                                       {
 
         if (toolTypeAndName == "")
             toolTypeAndName = System::typeinfoName(typeid(T));
 
         StatusCode sc = handle.initialize(toolTypeAndName, this, createIf);
 
         MsgStream log(msgSvc(), name());
 
         if (sc.isSuccess()) {
             log << MSG::DEBUG << "Handle for private tool" << toolTypeAndName
                     << " successfully created and stored." << endmsg;
         } else {
 
             log << MSG::ERROR << "Handle for private tool" << toolTypeAndName
                     << " could not be created." << endmsg;
         }
 
         return sc;
 
     }

template<class T >

Property* Service::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)		const

inline

Declare the named property.

MySvc ( const std::string& name ,
        ISvcLocator*       pSvc )
   : Service ( name , pSvc )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;
   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MySvc::handler_2 ) ;
 }

See also: PropertyMgr; PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns: the actual property objects

Definition at line 212 of file Service.h.

   {
     return m_propertyMgr -> declareProperty ( name , property , doc ) ;
   }

template<class T >

Property* Service::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)		const

inline

Declare the named property.

MySvc ( const std::string& name ,
        ISvcLocator*       pSvc )
   : Service ( name , pSvc )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;
   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MySvc::handler_2 ) ;
 }

See also: PropertyMgr; PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns: the actual property objects

Definition at line 212 of file Service.h.

   {
     return m_propertyMgr -> declareProperty ( name , property , doc ) ;
   }

template<class T >

StatusCode Service::declarePublicTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Public tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 274 of file Service.h.

                                       {
 
         if (toolTypeAndName == "")
             toolTypeAndName = System::typeinfoName(typeid(T));
 
         StatusCode sc = handle.initialize(toolTypeAndName, 0, createIf);
 
         MsgStream log(msgSvc(), name());
 
         if (sc.isSuccess()) {
             log << MSG::DEBUG << "Handle for public tool" << toolTypeAndName
                     << " successfully created and stored." << endmsg;
         } else {
 
             log << MSG::ERROR << "Handle for public tool" << toolTypeAndName
                     << " could not be created." << endmsg;
         }
 
         return sc;
 
     }

template<class T >

StatusCode Service::declarePublicTool	(	ToolHandle< T > &	handle,
		std::string	toolTypeAndName = `""`,
		bool	createIf = `true`
	)

inline

Declare used Public tool.

Parameters

handle	ToolHandle<T>
toolTypeAndName
parent,default	public tool
create	if necessary, default true

Definition at line 274 of file Service.h.

                                       {
 
         if (toolTypeAndName == "")
             toolTypeAndName = System::typeinfoName(typeid(T));
 
         StatusCode sc = handle.initialize(toolTypeAndName, 0, createIf);
 
         MsgStream log(msgSvc(), name());
 
         if (sc.isSuccess()) {
             log << MSG::DEBUG << "Handle for public tool" << toolTypeAndName
                     << " successfully created and stored." << endmsg;
         } else {
 
             log << MSG::ERROR << "Handle for public tool" << toolTypeAndName
                     << " could not be created." << endmsg;
         }
 
         return sc;
 
     }

Property* Service::declareRemoteProperty	(	const std::string &	name,
		IProperty *	rsvc,
		const std::string &	rname = `""`
	)		const

inline

Declare remote named properties.

This is used to declare as a local property a property of another services or algorithm. The only needed information is IProperty interface of the remote service and the its property name if different of the current one.

Parameters

name	Local property name
rsvc	Remote IProperty interface
rname	Name of the property at remote service

Definition at line 228 of file Service.h.

   {
     return m_propertyMgr -> declareRemoteProperty ( name , rsvc , rname ) ;
   }

Property* Service::declareRemoteProperty	(	const std::string &	name,
		IProperty *	rsvc,
		const std::string &	rname = `""`
	)		const

inline

Declare remote named properties.

This is used to declare as a local property a property of another services or algorithm. The only needed information is IProperty interface of the remote service and the its property name if different of the current one.

Parameters

name	Local property name
rsvc	Remote IProperty interface
rname	Name of the property at remote service

Definition at line 228 of file Service.h.

   {
     return m_propertyMgr -> declareRemoteProperty ( name , rsvc , rname ) ;
   }

StatusCode Service::finalize ( )

override

StatusCode Service::finalize ( )

override

Definition at line 188 of file Service.cpp.

                              {
   //MsgStream log(msgSvc(),name());
   //m_state = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::TERMINATE,m_state);
   return StatusCode::SUCCESS;
 }

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

inlineoverride

Definition at line 54 of file Service.h.

54 { return m_state; }

Service::m_state

Gaudi::StateMachine::State m_state

Service state.

Definition: Service.h:309

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

inlineoverride

Definition at line 54 of file Service.h.

54 { return m_state; }

Service::m_state

Gaudi::StateMachine::State m_state

Service state.

Definition: Service.h:309

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

override

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

override

Definition at line 355 of file Service.cpp.

                                                          {
   return m_propertyMgr->getProperties();
 }

StatusCode Service::getProperty ( Property * p ) const

override

Definition at line 343 of file Service.cpp.

                                                  {
   return m_propertyMgr->getProperty(p);
 }

StatusCode Service::getProperty ( Property * p ) const

override

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

override

Definition at line 347 of file Service.cpp.

                                                              {
   return m_propertyMgr->getProperty(n);
 }

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

override

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

override

Definition at line 351 of file Service.cpp.

                                                                        {
   return m_propertyMgr->getProperty(n,v);
 }

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

override

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

override

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

override

Definition at line 359 of file Service.cpp.

                                                      {
   return m_propertyMgr->hasProperty(name);
 }

StatusCode Service::initialize ( )

override

StatusCode Service::initialize ( )

override

Definition at line 63 of file Service.cpp.

                                {
   // Set the Algorithm's properties
   StatusCode sc = setProperties();
   ON_DEBUG debug() <<  "Service base class initialized successfully" << endmsg;
   m_state = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::CONFIGURE,m_state);
   return sc ;
 }

void Service::initOutputLevel ( Property & prop )

private

callback for output level property

void Service::initOutputLevel ( Property & prop )

private

callback for output level property

Definition at line 423 of file Service.cpp.

                                          {
   if ( (name() != "MessageSvc") && msgSvc() ) {
     msgSvc()->setOutputLevel( name(), m_outputLevel );
   }
   updateMsgStreamOutputLevel(m_outputLevel);
 }

const std::string & Service::name ( ) const

override

Retrieve name of the service.

Definition at line 320 of file Service.cpp.

                                        {
   return m_name;
 }

const std::string& Service::name ( ) const

override

Retrieve name of the service.

int Service::outputLevel ( ) const

inlineprotected

get the Service's output level

Definition at line 314 of file Service.h.

314 { return m_outputLevel.value(); }

Service::m_outputLevel

IntegerProperty m_outputLevel

Service output level.

Definition: Service.h:307

PropertyWithValue::value

const TYPE & value() const

explicit conversion

Definition: Property.h:341

int Service::outputLevel ( ) const

inlineprotected

get the Service's output level

Definition at line 314 of file Service.h.

314 { return m_outputLevel.value(); }

Service::m_outputLevel

IntegerProperty m_outputLevel

Service output level.

Definition: Service.h:307

PropertyWithValue::value

const TYPE & value() const

explicit conversion

Definition: Property.h:341

StatusCode Service::reinitialize ( )

override

Definition at line 283 of file Service.cpp.

                                  {
   /* @TODO
    * MCl 2008-10-23: the implementation of reinitialize as finalize+initialize
    *                 is causing too many problems
    *
   // Default implementation is finalize+initialize
   StatusCode sc = finalize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be finalized" << endmsg;
     return sc;
   }
   sc = initialize();
   if (sc.isFailure()) {
     error() << "reinitialize(): cannot be initialized" << endmsg;
     return sc;
   }
   */
   return StatusCode::SUCCESS;
 }

StatusCode Service::reinitialize ( )

override

StatusCode Service::restart ( )

override

Definition at line 304 of file Service.cpp.

                             {
   // Default implementation is stop+start
   StatusCode sc = stop();
   if (sc.isFailure()) {
     error() << "restart(): cannot be stopped" << endmsg;
     return sc;
   }
   sc = start();
   if (sc.isFailure()) {
     error() << "restart(): cannot be started" << endmsg;
     return sc;
   }
   return StatusCode::SUCCESS;
 }

StatusCode Service::restart ( )

override

template<class T >

StatusCode Service::service	(	const std::string &	name,
		const T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 141 of file Service.h.

                                                                                           {
     ISvcLocator& svcLoc = *serviceLocator();
     auto ptr =
       ServiceLocatorHelper(svcLoc, *this).service<T>(name, !createIf, // quiet
                                                      createIf);
     if (ptr) {
       psvc = ptr.get();
       const_cast<T*>(psvc)->addRef();
       return StatusCode::SUCCESS;
     }
     // else
     psvc = nullptr;
     return StatusCode::FAILURE;
   }

template<class T >

StatusCode Service::service	(	const std::string &	name,
		const T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 141 of file Service.h.

                                                                                           {
     ISvcLocator& svcLoc = *serviceLocator();
     auto ptr =
       ServiceLocatorHelper(svcLoc, *this).service<T>(name, !createIf, // quiet
                                                      createIf);
     if (ptr) {
       psvc = ptr.get();
       const_cast<T*>(psvc)->addRef();
       return StatusCode::SUCCESS;
     }
     // else
     psvc = nullptr;
     return StatusCode::FAILURE;
   }

template<class T >

StatusCode Service::service	(	const std::string &	name,
		T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Definition at line 157 of file Service.h.

                                                                                     {
     auto  ptr = service<T>(name,createIf);
     psvc = ( ptr ? ptr.get() : nullptr );
     if (psvc) {
       psvc->addRef();
       return StatusCode::SUCCESS;
     }
     return StatusCode::FAILURE;
   }

template<class T >

StatusCode Service::service	(	const std::string &	name,
		T *&	psvc,
		bool	createIf = `true`
	)		const

inline

Definition at line 157 of file Service.h.

                                                                                     {
     auto  ptr = service<T>(name,createIf);
     psvc = ( ptr ? ptr.get() : nullptr );
     if (psvc) {
       psvc->addRef();
       return StatusCode::SUCCESS;
     }
     return StatusCode::FAILURE;
   }

template<typename IFace = IService>

SmartIF<IFace> Service::service	(	const std::string &	name,
		bool	createIf = `true`
	)		const

inline

Definition at line 168 of file Service.h.

                                                                             {
     return ServiceLocatorHelper(*serviceLocator(), *this).
                                service<IFace>(name, !createIf, // quiet
                                               createIf);
   }

template<typename IFace = IService>

SmartIF<IFace> Service::service	(	const std::string &	name,
		bool	createIf = `true`
	)		const

inline

Definition at line 168 of file Service.h.

                                                                             {
     return ServiceLocatorHelper(*serviceLocator(), *this).
                                service<IFace>(name, !createIf, // quiet
                                               createIf);
   }

template<class T >

StatusCode Service::service	(	const std::string &	svcType,
		const std::string &	svcName,
		T *&	psvc
	)		const

inline

Access a service by name and type, creating it if it doesn't already exist.

Definition at line 177 of file Service.h.

                               {
     return service(svcType + "/" + svcName, psvc);
   }

template<class T >

StatusCode Service::service	(	const std::string &	svcType,
		const std::string &	svcName,
		T *&	psvc
	)		const

inline

Access a service by name and type, creating it if it doesn't already exist.

Definition at line 177 of file Service.h.

                               {
     return service(svcType + "/" + svcName, psvc);
   }

SmartIF<ISvcLocator>& Service::serviceLocator ( ) const

override

Retrieve pointer to service locator.

SmartIF< ISvcLocator > & Service::serviceLocator ( ) const

override

Retrieve pointer to service locator.

Definition at line 325 of file Service.cpp.

                                                     {
   return m_svcLocator;
 }

StatusCode Service::setProperties ( )

Method for setting declared properties to the values specified for the job.

StatusCode Service::setProperties ( )

Method for setting declared properties to the values specified for the job.

Definition at line 364 of file Service.cpp.

                                   {
   const bool CREATEIF(true);
   auto jos = serviceLocator()->service<IJobOptionsSvc>("JobOptionsSvc", CREATEIF);
   if( !jos ) {
     throw GaudiException("Service [JobOptionsSvc] not found", name(), StatusCode::FAILURE);
   }
   // set first generic Properties
   StatusCode sc = jos->setMyProperties( getGaudiThreadGenericName(name()), this );
   if( sc.isFailure() ) return sc;
 
   // set specific Properties
   if (isGaudiThreaded(name())) {
     if (jos->setMyProperties( name(), this ).isFailure()) {
       return StatusCode::FAILURE;
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode Service::setProperty ( const Property & p )

override

Definition at line 331 of file Service.cpp.

                                                  {
   return m_propertyMgr->setProperty(p);
 }

StatusCode Service::setProperty ( const Property & p )

override

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

override

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

override

Definition at line 335 of file Service.cpp.

                                                   {
   return m_propertyMgr->setProperty(s);
 }

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

override

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

override

Definition at line 339 of file Service.cpp.

                                                                       {
   return m_propertyMgr->setProperty(n,v);
 }

template<class TYPE >

StatusCode Service::setProperty	(	const std::string &	name,
		const TYPE &	value
	)

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;
std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;
std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also: Gaudi::Utils::setProperty

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-05-13

Definition at line 124 of file Service.h.

126 { return Gaudi::Utils::setProperty ( m_propertyMgr.get() , name , value ) ; }

Gaudi::Utils::setProperty

StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)

simple function to set the property of the given object from the value

Definition: Property.h:1187

SmartIF::get

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:320

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

Service::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: Service.h:323

template<class TYPE >

StatusCode Service::setProperty	(	const std::string &	name,
		const TYPE &	value
	)

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;
std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;
std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also: Gaudi::Utils::setProperty

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-05-13

Definition at line 124 of file Service.h.

126 { return Gaudi::Utils::setProperty ( m_propertyMgr.get() , name , value ) ; }

Gaudi::Utils::setProperty

StatusCode setProperty(IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)

simple function to set the property of the given object from the value

Definition: Property.h:1187

SmartIF::get

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:320

dump_component_properties.value

list value

Definition: dump_component_properties.py:12

Service::m_propertyMgr

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: Service.h:323

void Service::setServiceManager ( ISvcManager * ism )

overrideprivate

Definition at line 442 of file Service.cpp.

                                            {
   m_svcManager = ism;
 }

void Service::setServiceManager ( ISvcManager * ism )

overrideprivate

StatusCode Service::start ( )

override

StatusCode Service::start ( )

override

Definition at line 147 of file Service.cpp.

                           {
   // stub implementation
   return StatusCode::SUCCESS;
 }

StatusCode Service::stop ( )

override

StatusCode Service::stop ( )

override

Definition at line 141 of file Service.cpp.

                          {
   // stub implementation
   return StatusCode::SUCCESS;
 }

StatusCode Service::sysFinalize ( )

override

Finalize Service.

StatusCode Service::sysFinalize ( )

override

Finalize Service.

Definition at line 153 of file Service.cpp.

                                 {
 
   StatusCode sc(StatusCode::FAILURE);
 
   try {
     m_targetState = Gaudi::StateMachine::OFFLINE;
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorFinalize) ? auditorSvc().get() : nullptr,
                                       IAuditor::Finalize);
     sc = finalize();
     if (sc.isSuccess())
       m_state = m_targetState;
   }
   catch( const GaudiException& Exception ) {
     fatal() << " Exception with tag=" << Exception.tag()
         << " is caught " << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   }
   catch( const std::exception& Exception ) {
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   }
   catch( ... ) {
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
 
   m_pAuditorSvc = nullptr;
   return sc;
 }

StatusCode Service::sysInitialize ( )

override

Initialize Service.

Definition at line 26 of file Service.cpp.

                                   {
   StatusCode sc;
 
   try {
     m_targetState = Gaudi::StateMachine::INITIALIZED;
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorInitialize) ? auditorSvc().get() : nullptr,
                                       IAuditor::Initialize);
     if ((name() != "MessageSvc") && msgSvc()) // pre-set the outputLevel from the MessageSvc value
       m_outputLevel = msgSvc()->outputLevel(name());
     sc = initialize(); // This should change the state to Gaudi::StateMachine::CONFIGURED
     if (sc.isSuccess())
       m_state = m_targetState;
     return sc;
   }
   catch ( const GaudiException& Exception )  {
     fatal() << "in sysInitialize(): exception with tag=" << Exception.tag()
         << " is caught" << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   }
   catch( const std::exception& Exception ) {
     fatal() << "in sysInitialize(): standard std::exception is caught" << endmsg;
     error() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   }
   catch(...) {
     fatal() << "in sysInitialize(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
 
   return StatusCode::FAILURE;
 }

StatusCode Service::sysInitialize ( )

override

Initialize Service.

StatusCode Service::sysReinitialize ( )

override

Re-initialize the Service.

Definition at line 195 of file Service.cpp.

                                     {
 
   StatusCode sc;
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
     MsgStream log ( msgSvc() , name() );
     error()
         << "sysReinitialize(): cannot reinitialize service not initialized"
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   try {
 
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorReinitialize) ? auditorSvc().get() : nullptr,
                                       IAuditor::ReInitialize);
     sc = reinitialize();
     return sc;
   }
   catch( const GaudiException& Exception ) {
     MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
     fatal() << " Exception with tag=" << Exception.tag()
         << " is caught " << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   }
   catch( const std::exception& Exception ) {
     MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   }
   catch( ... ) {
     MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
   return StatusCode::FAILURE ;
 
 }

StatusCode Service::sysReinitialize ( )

override

Re-initialize the Service.

StatusCode Service::sysRestart ( )

override

Re-initialize the Service.

StatusCode Service::sysRestart ( )

override

Re-initialize the Service.

Definition at line 240 of file Service.cpp.

                                {
 
   StatusCode sc;
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
     MsgStream log ( msgSvc() , name() );
     error()
         << "sysRestart(): cannot restart service in state " << FSMState()
         << " -- must be RUNNING "
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   try {
 
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorRestart) ? auditorSvc().get() : nullptr,
                                       IAuditor::ReStart);
     sc = restart();
     return sc;
   }
   catch( const GaudiException& Exception ) {
     fatal() << " Exception with tag=" << Exception.tag()
         << " is caught " << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() ) ;
   }
   catch( const std::exception& Exception ) {
     fatal() << " Standard std::exception is caught " << endmsg;
     error() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" ) ;
   }
   catch( ... ) {
     fatal() << "UNKNOWN Exception is caught " << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
   return StatusCode::FAILURE ;
 
 }

StatusCode Service::sysStart ( )

override

Initialize Service.

Definition at line 72 of file Service.cpp.

                              {
   StatusCode sc;
 
   try {
     m_targetState = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::START,m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorStart) ? auditorSvc().get() : nullptr,
                                       IAuditor::Start);
     sc = start();
     if (sc.isSuccess())
       m_state = m_targetState;
     return sc;
   }
   catch ( const GaudiException& Exception )  {
     fatal() << "in sysStart(): exception with tag=" << Exception.tag()
         << " is caught" << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   }
   catch( const std::exception& Exception ) {
     fatal() << "in sysStart(): standard std::exception is caught" << endmsg;
     fatal() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   }
   catch(...) {
     fatal() << "in sysStart(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
 
   return StatusCode::FAILURE;
 }

StatusCode Service::sysStart ( )

override

Initialize Service.

StatusCode Service::sysStop ( )

override

Initialize Service.

Definition at line 106 of file Service.cpp.

                             {
   StatusCode sc;
 
   try {
     m_targetState = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::STOP,m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       (m_auditorStop) ? auditorSvc().get() : nullptr,
                                       IAuditor::Stop);
     sc = stop();
     if (sc.isSuccess())
       m_state = m_targetState;
     return sc;
   }
   catch ( const GaudiException& Exception )  {
     fatal() << "in sysStop(): exception with tag=" << Exception.tag()
         << " is caught" << endmsg;
     error() << Exception  << endmsg;
     //    Stat stat( chronoSvc() , Exception.tag() );
   }
   catch( const std::exception& Exception ) {
     fatal() << "in sysStop(): standard std::exception is caught" << endmsg;
     error() << Exception.what()  << endmsg;
     //    Stat stat( chronoSvc() , "*std::exception*" );
   }
   catch(...) {
     fatal() << "in sysStop(): UNKNOWN Exception is caught" << endmsg;
     //    Stat stat( chronoSvc() , "*UNKNOWN Exception*" ) ;
   }
 
   return StatusCode::FAILURE;
 }

StatusCode Service::sysStop ( )

override

Initialize Service.

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

inlineoverride

Definition at line 55 of file Service.h.

55 { return m_targetState; }

Service::m_targetState

Gaudi::StateMachine::State m_targetState

Service state.

Definition: Service.h:311

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

inlineoverride

Definition at line 55 of file Service.h.

55 { return m_targetState; }

Service::m_targetState

Gaudi::StateMachine::State m_targetState

Service state.

Definition: Service.h:311

StatusCode Service::terminate ( )

inlineoverride

Definition at line 53 of file Service.h.

53 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

StatusCode Service::terminate ( )

inlineoverride

Definition at line 53 of file Service.h.

53 { return StatusCode::SUCCESS; }

StatusCode::SUCCESS

Definition: StatusCode.h:30

Friends And Related Function Documentation

ServiceManager

friend

Definition at line 42 of file Service.h.

Member Data Documentation

BooleanProperty Service::m_auditInit

private

Definition at line 329 of file Service.h.

bool Service::m_auditorFinalize

private

Definition at line 333 of file Service.h.

bool Service::m_auditorInitialize

private

Definition at line 330 of file Service.h.

bool Service::m_auditorReinitialize

private

Definition at line 334 of file Service.h.

bool Service::m_auditorRestart

private

Definition at line 335 of file Service.h.

bool Service::m_auditorStart

private

Definition at line 331 of file Service.h.

bool Service::m_auditorStop

private

Definition at line 332 of file Service.h.

std::string Service::m_name

private

Service Name.

Definition at line 318 of file Service.h.

IntegerProperty Service::m_outputLevel = MSG::NIL

protected

Service output level.

Definition at line 307 of file Service.h.

SmartIF< IAuditorSvc > Service::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 328 of file Service.h.

SmartIF< PropertyMgr > Service::m_propertyMgr

private

Property Manager.

Definition at line 323 of file Service.h.

Gaudi::StateMachine::State Service::m_state = Gaudi::StateMachine::OFFLINE

protected

Service state.

Definition at line 309 of file Service.h.

SmartIF< ISvcLocator > Service::m_svcLocator

mutableprivate

Service Locator reference.

Definition at line 320 of file Service.h.

SmartIF< ISvcManager > Service::m_svcManager

private

Definition at line 321 of file Service.h.

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

protected

Service state.

Definition at line 311 of file Service.h.

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

InstallArea/x86_64-slc6-gcc49-opt/include/GaudiKernel/Service.h
GaudiKernel/src/Lib/Service.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation