The Gaudi Framework: AlgTool Class Reference

Definition: StatusCode.h:30

StatusCode AlgTool::configure ( )

inlineoverride

Definition at line 57 of file AlgTool.h.

57 { return StatusCode::SUCCESS; }

Definition: StatusCode.h:30

template<class T >

void AlgTool::declareInfo	(	const std::string &	name,
		const T &	var,
		const std::string &	desc
	)		const

inline

Declare monitoring information.

Parameters

name	Monitoring information name known to the external system
var	Monitoring Listener address (the item to monitor...)
desc	Textual description of the information being monitored

Definition at line 274 of file AlgTool.h.

   {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo(name, var, desc, this);
   }

template<class T >

void AlgTool::declareInfo	(	const std::string &	name,
		const T &	var,
		const std::string &	desc
	)		const

inline

Declare monitoring information.

Parameters

name	Monitoring information name known to the external system
var	Monitoring Listener address (the item to monitor...)
desc	Textual description of the information being monitored

Definition at line 274 of file AlgTool.h.

   {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo(name, var, desc, this);
   }

void AlgTool::declareInfo	(	const std::string &	name,
		const std::string &	format,
		const void *	var,
		int	size,
		const std::string &	desc
	)		const

inline

Declare monitoring information (special case)

Parameters

name	Monitoring information name known to the external system
format	Format information
var	Monitoring Listener address
size	Monitoring Listener address size
desc	Textual description of the information being monitored

Definition at line 289 of file AlgTool.h.

   {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo(name, format, var, size, desc, this);
   }

void AlgTool::declareInfo	(	const std::string &	name,
		const std::string &	format,
		const void *	var,
		int	size,
		const std::string &	desc
	)		const

inline

Declare monitoring information (special case)

Parameters

name	Monitoring information name known to the external system
format	Format information
var	Monitoring Listener address
size	Monitoring Listener address size
desc	Textual description of the information being monitored

Definition at line 289 of file AlgTool.h.

   {
     IMonitorSvc* mS = monitorSvc();
     if ( mS ) mS->declareInfo(name, format, var, size, desc, this);
   }

template<typename I >

void AlgTool::declareInterface ( I * i )

inlineprotected

Definition at line 200 of file AlgTool.h.

200 { m_interfaceList.emplace_back( I::interfaceID(), i ); }

AlgTool::m_interfaceList

InterfaceList m_interfaceList

Interface list.

Definition: AlgTool.h:329

ana.i

list i

Definition: ana.py:128

template<typename I >

void AlgTool::declareInterface ( I * i )

inlineprotected

Definition at line 200 of file AlgTool.h.

200 { m_interfaceList.emplace_back( I::interfaceID(), i ); }

AlgTool::m_interfaceList

InterfaceList m_interfaceList

Interface list.

Definition: AlgTool.h:329

ana.i

list i

Definition: ana.py:128

template<class T >

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

inline

Declare the named property.

MyTool ( const std::string& type   ,
         const std::string& name   ,
         const IInterface*  parent )
   : AlgTool  ( type , 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( &MyTool::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 234 of file AlgTool.h.

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

template<class T >

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

inline

Declare the named property.

MyTool ( const std::string& type   ,
         const std::string& name   ,
         const IInterface*  parent )
   : AlgTool  ( type , 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( &MyTool::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 234 of file AlgTool.h.

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

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

inline

Declare remote named properties.

Definition at line 242 of file AlgTool.h.

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

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

inline

Declare remote named properties.

Definition at line 242 of file AlgTool.h.

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

StatusCode AlgTool::finalize ( )

override

Definition at line 351 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::finalize ( )

override

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

inlineoverride

Definition at line 65 of file AlgTool.h.

65 { return m_state; }

AlgTool::m_state

Gaudi::StateMachine::State m_state

state of the Tool

Definition: AlgTool.h:352

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

inlineoverride

Definition at line 65 of file AlgTool.h.

65 { return m_state; }

AlgTool::m_state

Gaudi::StateMachine::State m_state

state of the Tool

Definition: AlgTool.h:352

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

override

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

override

Definition at line 151 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperties();
 }

StatusCode AlgTool::getProperty ( Property * p ) const

override

StatusCode AlgTool::getProperty ( Property * p ) const

override

Definition at line 131 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperty(p);
 }

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

override

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

override

Definition at line 138 of file AlgTool.cpp.

 {
   return m_propertyMgr->getProperty(n);
 }

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

override

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

override

Definition at line 144 of file AlgTool.cpp.

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

PropertyMgr* AlgTool::getPropertyMgr ( )

inline

Definition at line 96 of file AlgTool.h.

96 { return m_propertyMgr.get(); }

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:328

PropertyMgr* AlgTool::getPropertyMgr ( )

inline

Definition at line 96 of file AlgTool.h.

96 { return m_propertyMgr.get(); }

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:328

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

override

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

override

Definition at line 157 of file AlgTool.cpp.

                                                      {
   return m_propertyMgr->hasProperty(name);
 }

StatusCode AlgTool::initialize ( )

override

Definition at line 281 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   // Setting the properties is done by the ToolSvc calling setProperties()
   // explicitly.
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::initialize ( )

override

void AlgTool::initOutputLevel ( Property & prop )

protected

callback for output level property

Definition at line 496 of file AlgTool.cpp.

                                           {
 //-----------------------------------------------------------------------------
    // do nothing... yet ?
 }

void AlgTool::initOutputLevel ( Property & prop )

protected

callback for output level property

IMonitorSvc* AlgTool::monitorSvc ( ) const

inline

Access the monitor service.

Attention: Note that this method will return a NULL pointer if no monitor service is configured to be present. You must take this possibility into account when using the pointer

Returns: Pointer to the Monitor service

Return values

NULL	No monitor service is present
non-NULL	A monitor service is present and available to be used

Definition at line 261 of file AlgTool.h.

   {
     // If not already located try to locate it without forcing a creation
     if ( !m_pMonitorSvc ) m_pMonitorSvc = service(m_monitorSvcName, false, true);
     return m_pMonitorSvc.get();
   }

IMonitorSvc* AlgTool::monitorSvc ( ) const

inline

Access the monitor service.

Attention: Note that this method will return a NULL pointer if no monitor service is configured to be present. You must take this possibility into account when using the pointer

Returns: Pointer to the Monitor service

Return values

NULL	No monitor service is present
non-NULL	A monitor service is present and available to be used

Definition at line 261 of file AlgTool.h.

   {
     // If not already located try to locate it without forcing a creation
     if ( !m_pMonitorSvc ) m_pMonitorSvc = service(m_monitorSvcName, false, true);
     return m_pMonitorSvc.get();
   }

IMessageSvc * AlgTool::msgSvc ( ) const

Retrieve pointer to message service.

Definition at line 90 of file AlgTool.cpp.

 {
   return m_messageSvc;
 }

IMessageSvc* AlgTool::msgSvc ( ) const

Retrieve pointer to message service.

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

override

Retrieve full identifying name of the concrete tool object.

Definition at line 62 of file AlgTool.cpp.

 {
   return m_name;
 }

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

override

Retrieve full identifying name of the concrete tool object.

int AlgTool::outputLevel ( ) const

inlineprotected

get tool's output level

Definition at line 302 of file AlgTool.h.

302 { return (int)m_outputLevel ; }

IntegerProperty m_outputLevel

AlgTool output level.

Definition: AlgTool.h:319

int AlgTool::outputLevel ( ) const

inlineprotected

get tool's output level

Definition at line 302 of file AlgTool.h.

302 { return (int)m_outputLevel ; }

IntegerProperty m_outputLevel

AlgTool output level.

Definition: AlgTool.h:319

IntegerProperty& AlgTool::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 305 of file AlgTool.h.

305 { return m_outputLevel; }

IntegerProperty m_outputLevel

AlgTool output level.

Definition: AlgTool.h:319

IntegerProperty& AlgTool::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 305 of file AlgTool.h.

305 { return m_outputLevel; }

IntegerProperty m_outputLevel

AlgTool output level.

Definition: AlgTool.h:319

const IInterface * AlgTool::parent ( ) const

override

Retrieve parent of the sub-algtool.

Definition at line 76 of file AlgTool.cpp.

 {
   return m_parent;
 }

const IInterface* AlgTool::parent ( ) const

override

Retrieve parent of the sub-algtool.

StatusCode AlgTool::queryInterface	(	const InterfaceID &	riid,
		void **	ppvUnknown
	)

override

Query for a given interface.

Definition at line 42 of file AlgTool.cpp.

 {
   if ( !ppvi ) { return StatusCode::FAILURE ; } // RETURN
   StatusCode sc = base_class::queryInterface(riid,ppvi);
   if (sc.isSuccess()) return sc;
   auto i = std::find_if( std::begin(m_interfaceList), std::end(m_interfaceList),
                          [&](const std::pair<InterfaceID,void*>& item) {
                              return item.first.versionMatch(riid);
   } );
   if ( i == std::end(m_interfaceList) ) {
     *ppvi = nullptr ;
     return NO_INTERFACE ;  // RETURN
   }
   *ppvi = i->second ;
   addRef() ;
   return SUCCESS ;     // RETURN
 }

StatusCode AlgTool::queryInterface	(	const InterfaceID &	riid,
		void **	ppvUnknown
	)

override

Query for a given interface.

StatusCode AlgTool::reinitialize ( )

override

Definition at line 382 of file AlgTool.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()) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR << "reinitialize(): cannot be finalized" << endmsg;
     return sc;
   }
   sc = initialize();
   if (sc.isFailure()) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR << "reinitialize(): cannot be initialized" << endmsg;
     return sc;
   }
   */
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::reinitialize ( )

override

StatusCode AlgTool::restart ( )

override

Definition at line 430 of file AlgTool.cpp.

 {
   // Default implementation is stop+start
   StatusCode sc = stop();
   if (sc.isFailure()) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR << "restart(): cannot be stopped" << endmsg;
     return sc;
   }
   sc = start();
   if (sc.isFailure()) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR << "restart(): cannot be started" << endmsg;
     return sc;
   }
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::restart ( )

override

template<class T >

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

inline

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

Definition at line 180 of file AlgTool.h.

                                                                  {
     return service_i(name, createIf, T::interfaceID(), (void**)&svc);
   }

template<class T >

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

inline

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

Definition at line 180 of file AlgTool.h.

                                                                  {
     return service_i(name, createIf, T::interfaceID(), (void**)&svc);
   }

template<class T >

StatusCode AlgTool::service	(	const std::string &	type,
		const std::string &	name,
		T *&	svc
	)		const

inline

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

Definition at line 187 of file AlgTool.h.

                                                                                    {
     return service_i(type, name, T::interfaceID(), (void**)&svc);
   }

template<class T >

StatusCode AlgTool::service	(	const std::string &	type,
		const std::string &	name,
		T *&	svc
	)		const

inline

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

Definition at line 187 of file AlgTool.h.

                                                                                    {
     return service_i(type, name, T::interfaceID(), (void**)&svc);
   }

SmartIF< IService > AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

Return a pointer to the service identified by name (or "type/name")

Definition at line 477 of file AlgTool.cpp.

                                                                                                      {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return helper.service(name, quiet, createIf);
 }

SmartIF<IService> AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

Return a pointer to the service identified by name (or "type/name")

template<typename T >

SmartIF<T> AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

inline

Definition at line 195 of file AlgTool.h.

196 { return SmartIF<T>( service(name,createIf,quiet) ); }

SmartIF

Small smart pointer class with automatic reference counting for IInterface.

Definition: IConverter.h:14

AlgTool::service

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

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

Definition: AlgTool.h:180

const std::string & name() const override

Retrieve full identifying name of the concrete tool object.

Definition: AlgTool.cpp:62

template<typename T >

SmartIF<T> AlgTool::service	(	const std::string &	name,
		const bool	createIf = `true`,
		const bool	quiet = `false`
	)		const

inline

Definition at line 195 of file AlgTool.h.

196 { return SmartIF<T>( service(name,createIf,quiet) ); }

SmartIF

Small smart pointer class with automatic reference counting for IInterface.

Definition: IConverter.h:14

AlgTool::service

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

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

Definition: AlgTool.h:180

Gaudi::Utils::setProperty

const std::string & name() const override

Retrieve full identifying name of the concrete tool object.

Definition: AlgTool.cpp:62

StatusCode AlgTool::service_i	(	const std::string &	algName,
		bool	createIf,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

private

implementation of service method

StatusCode AlgTool::service_i	(	const std::string &	algName,
		bool	createIf,
		const InterfaceID &	iid,
		void **	ppSvc
	)		const

private

implementation of service method

Definition at line 459 of file AlgTool.cpp.

                                        {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return helper.getService(svcName, createIf, iid, ppSvc);
 }

StatusCode AlgTool::service_i	(	const std::string &	svcType,
		const std::string &	svcName,
		const InterfaceID &	iid,
		void **	ppS
	)		const

private

StatusCode AlgTool::service_i	(	const std::string &	svcType,
		const std::string &	svcName,
		const InterfaceID &	iid,
		void **	ppS
	)		const

private

Definition at line 469 of file AlgTool.cpp.

                                        {
   const ServiceLocatorHelper helper(*serviceLocator(), *this);
   return  helper.createService(svcType, svcName, iid, ppSvc);
 }

ISvcLocator* AlgTool::serviceLocator ( ) const

Retrieve pointer to service locator.

ISvcLocator * AlgTool::serviceLocator ( ) const

Retrieve pointer to service locator.

Definition at line 83 of file AlgTool.cpp.

 {
   return m_svcLocator;
 }

StatusCode AlgTool::setProperties ( )

Method for setting declared properties to the values specified in the jobOptions via the job option service.

This method is called by the ToolSvc after creating the concrete tool, before passing it to the requesting parent and does not need to be called explicitly.

Definition at line 162 of file AlgTool.cpp.

 {
   if( !m_svcLocator ) return StatusCode::FAILURE;
   auto jos = m_svcLocator->service<IJobOptionsSvc>("JobOptionsSvc");
   if( !jos )  return StatusCode::FAILURE;
 
   // set first generic Properties
   StatusCode sc = jos->setMyProperties( getGaudiThreadGenericName(name()), this );
   if( sc.isFailure() ) return StatusCode::FAILURE;
 
   // set specific Properties
   if (isGaudiThreaded(name())) {
     if(jos->setMyProperties( name(), this ).isFailure()) {
       return StatusCode::FAILURE;
     }
   }
 
   // Change my own outputlevel
   if ( m_messageSvc ) {
     if ( MSG::NIL != m_outputLevel )
     { m_messageSvc -> setOutputLevel ( name (), m_outputLevel ) ; }
     m_outputLevel = m_messageSvc -> outputLevel ( name () ) ;
   }
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::setProperties ( )

Method for setting declared properties to the values specified in the jobOptions via the job option service.

This method is called by the ToolSvc after creating the concrete tool, before passing it to the requesting parent and does not need to be called explicitly.

StatusCode AlgTool::setProperty ( const Property & p )

override

Default implementations for IProperty interface.

StatusCode AlgTool::setProperty ( const Property & p )

override

Default implementations for IProperty interface.

Definition at line 110 of file AlgTool.cpp.

 {
   return m_propertyMgr->setProperty(p);
 }

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

override

Definition at line 117 of file AlgTool.cpp.

 {
   return m_propertyMgr->setProperty(s);
 }

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

override

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

override

Definition at line 124 of file AlgTool.cpp.

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

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

override

template<class TYPE >

StatusCode AlgTool::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 142 of file AlgTool.h.

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

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

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

dump_component_properties.value

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:328

list value

Definition: dump_component_properties.py:12

Gaudi::Utils::setProperty

const std::string & name() const override

Retrieve full identifying name of the concrete tool object.

Definition: AlgTool.cpp:62

template<class TYPE >

StatusCode AlgTool::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 142 of file AlgTool.h.

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

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

TYPE * get() const

Get interface pointer.

Definition: SmartIF.h:76

dump_component_properties.value

SmartIF< PropertyMgr > m_propertyMgr

Property Manager.

Definition: AlgTool.h:328

list value

Definition: dump_component_properties.py:12

const std::string & name() const override

Retrieve full identifying name of the concrete tool object.

Definition: AlgTool.cpp:62

StatusCode AlgTool::start ( )

override

StatusCode AlgTool::start ( )

override

Definition at line 306 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::stop ( )

override

Definition at line 329 of file AlgTool.cpp.

 {
   // For the time being there is nothing to be done here.
   return StatusCode::SUCCESS;
 }

StatusCode AlgTool::stop ( )

override

ISvcLocator* AlgTool::svcLoc ( ) const

inline

shortcut for the method service locator

Definition at line 160 of file AlgTool.h.

160 { return serviceLocator() ; }

AlgTool::serviceLocator

ISvcLocator * serviceLocator() const

Retrieve pointer to service locator.

Definition: AlgTool.cpp:83

ISvcLocator* AlgTool::svcLoc ( ) const

inline

shortcut for the method service locator

Definition at line 160 of file AlgTool.h.

160 { return serviceLocator() ; }

AlgTool::serviceLocator

ISvcLocator * serviceLocator() const

Retrieve pointer to service locator.

Definition: AlgTool.cpp:83

StatusCode AlgTool::sysFinalize ( )

override

Finalize AlgTool.

StatusCode AlgTool::sysFinalize ( )

override

Finalize AlgTool.

Definition at line 337 of file AlgTool.cpp.

                                 {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysFinalize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::FINALIZE, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorFinalize ? auditorSvc() : nullptr,
                                       IAuditor::Finalize);
     StatusCode sc = finalize();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

StatusCode AlgTool::sysInitialize ( )

override

Initialize AlgTool.

StatusCode AlgTool::sysInitialize ( )

override

Initialize AlgTool.

Definition at line 267 of file AlgTool.cpp.

                                   {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysInitialize", [&]() {
     m_targetState = Gaudi::StateMachine::ChangeState( Gaudi::StateMachine::INITIALIZE, m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorInitialize ? auditorSvc() : nullptr,
                                       IAuditor::Initialize);
     StatusCode sc = initialize();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

StatusCode AlgTool::sysReinitialize ( )

override

Initialize AlgTool.

Definition at line 359 of file AlgTool.cpp.

                                     {
 //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::INITIALIZED != FSMState() ) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR
         << "sysReinitialize(): cannot reinitialize tool not initialized"
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt(*this, "SysReinitialize()", [&]() {
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorReinitialize ? auditorSvc() : nullptr,
                                       IAuditor::ReInitialize);
     return reinitialize();
   } );
 
 }

StatusCode AlgTool::sysReinitialize ( )

override

Initialize AlgTool.

StatusCode AlgTool::sysRestart ( )

override

Start AlgTool.

StatusCode AlgTool::sysRestart ( )

override

Start AlgTool.

Definition at line 407 of file AlgTool.cpp.

                                {
 //-----------------------------------------------------------------------------
 
   // Check that the current status is the correct one.
   if ( Gaudi::StateMachine::RUNNING != FSMState() ) {
     MsgStream log ( msgSvc(), name() );
     log << MSG::ERROR
         << "sysRestart(): cannot reinitialize tool not started"
         << endmsg;
     return StatusCode::FAILURE;
   }
 
   return attempt(*this, "sysRestart", [&]()  {
     m_targetState = Gaudi::StateMachine::ChangeState(Gaudi::StateMachine::START,m_state);
     Gaudi::Guards::AuditorGuard guard(this,
                                       // check if we want to audit the initialize
                                       m_auditorRestart ? auditorSvc() : nullptr,
                                       IAuditor::ReStart);
     return restart();
   } );
 }

StatusCode AlgTool::sysStart ( )

override

Start AlgTool.

StatusCode AlgTool::sysStart ( )

override

Start AlgTool.

Definition at line 291 of file AlgTool.cpp.

                              {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysInitialize", [&]() {
     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() : nullptr,
                                       IAuditor::Start);
     StatusCode sc = start();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

StatusCode AlgTool::sysStop ( )

override

Stop AlgTool.

StatusCode AlgTool::sysStop ( )

override

Stop AlgTool.

Definition at line 314 of file AlgTool.cpp.

                             {
 //-----------------------------------------------------------------------------
   return attempt( *this, "sysStop", [&]() {
     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() : nullptr,
                                       IAuditor::Stop);
     StatusCode sc = stop();
     if (sc.isSuccess()) m_state = m_targetState;
     return sc;
   } );
 }

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

inlineoverride

Definition at line 66 of file AlgTool.h.

66 { return m_targetState; }

AlgTool::m_targetState

Gaudi::StateMachine::State m_targetState

state of the Tool

Definition: AlgTool.h:353

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

inlineoverride

Definition at line 66 of file AlgTool.h.

66 { return m_targetState; }

AlgTool::m_targetState

Gaudi::StateMachine::State m_targetState

state of the Tool

Definition: AlgTool.h:353

StatusCode AlgTool::terminate ( )

inlineoverride

Definition at line 62 of file AlgTool.h.

62 { return StatusCode::SUCCESS; }

Definition: StatusCode.h:30

StatusCode AlgTool::terminate ( )

inlineoverride

Definition at line 62 of file AlgTool.h.

62 { return StatusCode::SUCCESS; }