AlgTool Class Reference

Base class from which all the concrete tool classes should be derived. More...

#include <GaudiKernel/AlgTool.h>

Inheritance diagram for AlgTool:

Collaboration diagram for AlgTool:

Classes
class	declareInterface

Public Types
typedef Gaudi::PluginService::Factory< IAlgTool *, const std::string &, const std::string &, const IInterface * >	Factory
Public Types inherited from implements3< IAlgTool, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...
typedef extend_interfaces3< IAlgTool, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
typedef mpl::fold< typename IAlgTool::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...
Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Member Functions
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown)
	Query for a given interface. More...
virtual const std::string &	name () const
	Retrieve full identifying name of the concrete tool object. More...
virtual const std::string &	type () const
	Retrieve type (concrete class) of the sub-algtool. More...
virtual const IInterface *	parent () const
	Retrieve parent of the sub-algtool. More...
virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...
virtual StatusCode	initialize ()
	Initialization (from CONFIGURED to INITIALIZED). More...
virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...
virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...
virtual StatusCode	finalize ()
	Finalize (from INITIALIZED to CONFIGURED). More...
virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...
virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...
virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...
virtual StatusCode	sysInitialize ()
	Initialize AlgTool. More...
virtual StatusCode	sysStart ()
	Start AlgTool. More...
virtual StatusCode	sysStop ()
	Stop AlgTool. More...
virtual StatusCode	sysFinalize ()
	Finalize AlgTool. More...
virtual StatusCode	sysReinitialize ()
	Initialize AlgTool. More...
virtual StatusCode	sysRestart ()
	Start AlgTool. More...
virtual StatusCode	setProperty (const Property &p)
	Default implementations for IProperty interface. More...
virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...
virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...
virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...
virtual const std::vector< Property * > &	getProperties () const
	Get list of properties. More...
virtual bool	hasProperty (const std::string &name) const
	Return true if we have a property with the given name. More...
PropertyMgr *	getPropertyMgr ()
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...
ISvcLocator *	serviceLocator () const
	Retrieve pointer to service locator. More...
ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...
IMessageSvc *	msgSvc () const
	Retrieve pointer to message service. More...
IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...
template<class T >
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. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&svc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	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") More...
void	declInterface (const InterfaceID &, void *)
	declare interface 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...
IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...
IMonitorSvc *	monitorSvc () const
	Access the monitor service. More...
template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...
Public Member Functions inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...
Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 3, 0)
	InterfaceID. More...
virtual	~IAlgTool ()
	Virtual destructor. More...
virtual unsigned long	refCount () const =0
	Current number of reference counts. More...
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...
virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual	~IInterface ()
	Virtual destructor. More...
Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 1)
	InterfaceID. More...
Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...
virtual	~IStateful ()

Protected Member Functions
int	outputLevel () const
	get tool's output level More...
IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...
void	initOutputLevel (Property &prop)
	callback for output level property More...
virtual	~AlgTool ()

Private Types
typedef std::list< std::pair< InterfaceID, void * > >	InterfaceList

Private Member Functions
StatusCode	service_i (const std::string &algName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	implementation of service method More...
StatusCode	service_i (const std::string &svcType, const std::string &svcName, const InterfaceID &iid, void **ppS) const

Private Attributes
IntegerProperty	m_outputLevel
	AlgTool output level. More...
std::string	m_type
	AlgTool type (concrete class name) More...
const std::string	m_name
	AlgTool full name. More...
const IInterface *	m_parent
	AlgTool parent. More...
ISvcLocator *	m_svcLocator
	Pointer to Service Locator service. More...
IMessageSvc *	m_messageSvc
	Message service. More...
IToolSvc *	m_ptoolSvc
	Tool service. More...
IMonitorSvc *	m_pMonitorSvc
	Online Monitoring Service. More...
std::string	m_monitorSvcName
	Name to use for Monitor Service. More...
PropertyMgr *	m_propertyMgr
	Property Manager. More...
InterfaceList	m_interfaceList
	Interface list. More...
std::string	m_threadID
	Thread Id for Alg Tool. More...
IAuditorSvc *	m_pAuditorSvc
	Auditor Service. More...
BooleanProperty	m_auditInit
bool	m_auditorInitialize
	flag for auditors in "initialize()" More...
bool	m_auditorStart
	flag for auditors in "start()" More...
bool	m_auditorStop
	flag for auditors in "stop()" More...
bool	m_auditorFinalize
	flag for auditors in "finalize()" More...
bool	m_auditorReinitialize
	flag for auditors in "reinitialize()" More...
bool	m_auditorRestart
	flag for auditors in "restart()" More...
Gaudi::StateMachine::State	m_state
	state of the Tool More...
Gaudi::StateMachine::State	m_targetState
	state of the Tool More...

Friends
class	ToolSvc

Additional Inherited Members
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Base class from which all the concrete tool classes should be derived.

Specific methods for doing something useful should be implemented in the concrete tools. Sub-types of this class could implement an additional interface for behavior common to sets of concrete tools (for example vertexers).

Author

Gloria Corti

Pere Mato

Definition at line 34 of file AlgTool.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory<IAlgTool*, const std::string&, const std::string&, const IInterface*> AlgTool::Factory

Definition at line 41 of file AlgTool.h.

typedef std::list<std::pair<InterfaceID,void*> > AlgTool::InterfaceList

private

Definition at line 322 of file AlgTool.h.

Constructor & Destructor Documentation

AlgTool::AlgTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard Constructor.

Parameters

type	the concrete class of the sub-algtool
name	the full name of the concrete sub-algtool
parent	the parent of the concrete sub-algtool

Definition at line 183 of file AlgTool.cpp.

  : m_outputLevel ( MSG::NIL )
  , m_type          ( type )
  , m_name          ( name )
  , m_parent        ( parent )
  , m_svcLocator    ( 0 )
  , m_messageSvc    ( 0 )
  , m_ptoolSvc      ( 0 )
  , m_pMonitorSvc   ( NULL )
  , m_propertyMgr   ( new PropertyMgr() )
  , m_interfaceList (       )
  , m_threadID      (       )
  , m_pAuditorSvc   ( 0     )
  , m_auditInit     ( false )
  , m_auditorInitialize(false)
  , m_auditorStart(false)
  , m_auditorStop(false)
  , m_auditorFinalize(false)
  , m_auditorReinitialize(false)
  , m_auditorRestart(false)
  , m_state         ( Gaudi::StateMachine::CONFIGURED )
  , m_targetState   ( Gaudi::StateMachine::CONFIGURED )
{
  addRef(); // Initial count set to 1

  declareProperty( "MonitorService", m_monitorSvcName = "MonitorSvc" );

  { // get the "OutputLevel" property from parent
    const Property* _p = Gaudi::Utils::getProperty ( parent , "OutputLevel") ;
    if ( 0 != _p ) { m_outputLevel.assign( *_p ) ; }
    declareProperty ( "OutputLevel"     , m_outputLevel ) ;
     m_outputLevel.declareUpdateHandler(&AlgTool::initOutputLevel, this);
  }

  IInterface* _p = const_cast<IInterface*> ( parent ) ;

  if      ( Algorithm* _alg = dynamic_cast<Algorithm*> ( _p ) )
  {
    m_svcLocator  = _alg -> serviceLocator  () ;
    m_messageSvc  = _alg -> msgSvc          () ;
    m_threadID    = getGaudiThreadIDfromName ( _alg -> name() ) ;
  }
  else if ( Service*   _svc = dynamic_cast<Service*>  ( _p ) )
  {
    m_svcLocator  = _svc -> serviceLocator () ;
    m_messageSvc  = _svc -> msgSvc         () ;
    m_threadID    = getGaudiThreadIDfromName ( _svc -> name() ) ;
  }
  else if ( AlgTool*   _too = dynamic_cast<AlgTool*>  ( _p ) )
  {
    m_svcLocator  = _too -> m_svcLocator;
    m_messageSvc  = _too -> m_messageSvc;
    m_threadID    = getGaudiThreadIDfromName ( _too ->m_threadID ) ;
  }
  else if ( Auditor*   _aud = dynamic_cast<Auditor*>  ( _p ) )
  {
    m_svcLocator  = _aud -> serviceLocator() ;
    m_messageSvc  = _aud -> msgSvc()         ;
    m_threadID    = getGaudiThreadIDfromName ( _aud -> name() )    ;
  }
  else
  {
    throw GaudiException
      ( "Failure to create tool '"
        + type + "/" + name + "': illegal parent type '"
        + System::typeinfoName(typeid(*_p)) + "'", "AlgTool", 0 );
  }


  { // audit tools
    SmartIF<IProperty> appMgr(m_svcLocator->service("ApplicationMgr"));
    if ( !appMgr.isValid() ) {
      throw GaudiException("Could not locate ApplicationMgr","AlgTool",0);
    }
    const Property* p = Gaudi::Utils::getProperty( appMgr , "AuditTools");
    if ( 0 != p ) { m_auditInit.assign ( *p ) ; }
    declareProperty ( "AuditTools", m_auditInit );
    bool audit = m_auditInit.value();
    // Declare common AlgTool properties with their defaults
    declareProperty ( "AuditInitialize" , m_auditorInitialize = audit ) ;
    declareProperty ( "AuditStart"      , m_auditorStart      = audit ) ;
    declareProperty ( "AuditStop"       , m_auditorStop       = audit ) ;
    declareProperty ( "AuditFinalize"   , m_auditorFinalize   = audit ) ;
  }

  // check thread ID and try if tool name indicates thread ID
  if ( m_threadID.empty() )
  { m_threadID = getGaudiThreadIDfromName ( AlgTool::name() ) ; }
}

AlgTool::~AlgTool ( )

protectedvirtual

Definition at line 572 of file AlgTool.cpp.

{
  delete m_propertyMgr;
  if( m_ptoolSvc ) m_ptoolSvc->release();
  if( m_pAuditorSvc ) m_pAuditorSvc->release();
  if ( m_pMonitorSvc ) { m_pMonitorSvc->undeclareAll(this); m_pMonitorSvc->release(); }
}

Member Function Documentation

IAuditorSvc * AlgTool::auditorSvc

(

)

const

Access the auditor service.

Definition at line 608 of file AlgTool.cpp.

                                       {
//---------------------------------------------------------------------------
  if ( 0 == m_pAuditorSvc ) {
    StatusCode sc = service( "AuditorSvc", m_pAuditorSvc, true );
    if( sc.isFailure() ) {
      throw GaudiException("Service [AuditorSvc] not found", name(), sc);
    }
  }
  return m_pAuditorSvc;
}

virtual StatusCode AlgTool::configure ( )

inlinevirtual

Configuration (from OFFLINE to CONFIGURED).

Implements IAlgTool.

Definition at line 57 of file AlgTool.h.

{ return StatusCode::SUCCESS; }

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 278 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 293 of file AlgTool.h.

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

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 235 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 243 of file AlgTool.h.

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

void AlgTool::declInterface	(	const InterfaceID &	iid,
		void *	ii
	)

declare interface

Definition at line 43 of file AlgTool.cpp.

{
  m_interfaceList.push_back(std::make_pair(iid, ii));
}

StatusCode AlgTool::finalize ( )

virtual

Finalize (from INITIALIZED to CONFIGURED).

Implements IAlgTool.

Reimplemented in GaudiHistos< GaudiTool >, GaudiCommon< AlgTool >, GaudiTuples< GaudiHistoTool >, GaudiTool, GaudiHistoTool, GaudiTupleTool, PartitionSwitchTool, SequencerTimerTool, DataStreamTool, FuncMinimum, GslErrorCount, DataSvcFileEntriesTool, and EqSolver.

Definition at line 438 of file AlgTool.cpp.

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

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

inlinevirtual

Get the current state.

Implements IAlgTool.

Definition at line 65 of file AlgTool.h.

{ return m_state; }

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

virtual

Get list of properties.

Implements IProperty.

Definition at line 140 of file AlgTool.cpp.

{
  return m_propertyMgr->getProperties();
}

StatusCode AlgTool::getProperty ( Property *  p ) const

virtual

Get the property by property.

Implements IProperty.

Definition at line 120 of file AlgTool.cpp.

{
  return m_propertyMgr->getProperty(p);
}

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

virtual

Get the property by name.

Implements IProperty.

Definition at line 127 of file AlgTool.cpp.

{
  return m_propertyMgr->getProperty(n);
}

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

virtual

Get the property by std::string.

Implements IProperty.

Definition at line 133 of file AlgTool.cpp.

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

PropertyMgr* AlgTool::getPropertyMgr ( )

inline

Definition at line 96 of file AlgTool.h.

{ return m_propertyMgr; }

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

virtual

Return true if we have a property with the given name.

Implements IProperty.

Definition at line 146 of file AlgTool.cpp.

                                                     {
  return m_propertyMgr->hasProperty(name);
}

StatusCode AlgTool::initialize ( )

virtual

Initialization (from CONFIGURED to INITIALIZED).

Implements IAlgTool.

Reimplemented in GaudiHistos< GaudiTool >, GaudiCommon< AlgTool >, GaudiTuples< GaudiHistoTool >, GaudiTool, GaudiHistoTool, GaudiTupleTool, SequencerTimerTool, FuncMinimum, DataStreamTool, PartitionSwitchTool, EqSolver, and DataSvcFileEntriesTool.

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

void AlgTool::initOutputLevel ( Property &  prop )

protected

callback for output level property

Definition at line 621 of file AlgTool.cpp.

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

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 262 of file AlgTool.h.

  {
    // If not already located try to locate it without forcing a creation
    if ( !m_pMonitorSvc ){
      service_i( m_monitorSvcName, false,
                 IMonitorSvc::interfaceID(), pp_cast<void>(&m_pMonitorSvc) ).ignore();
    }
    return m_pMonitorSvc;
  }

IMessageSvc * AlgTool::msgSvc

(

)

const

Retrieve pointer to message service.

Definition at line 79 of file AlgTool.cpp.

{
  return m_messageSvc;
}

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

virtual

Retrieve full identifying name of the concrete tool object.

Implements INamedInterface.

Definition at line 51 of file AlgTool.cpp.

{
  return m_name;
}

int AlgTool::outputLevel ( ) const

inlineprotected

get tool's output level

Definition at line 306 of file AlgTool.h.

{ return (int)m_outputLevel ; }

IntegerProperty& AlgTool::outputLevelProperty ( )

inlineprotected

Accessor for the Message level property.

Definition at line 309 of file AlgTool.h.

{ return m_outputLevel; }

const IInterface * AlgTool::parent ( ) const

virtual

Retrieve parent of the sub-algtool.

Implements IAlgTool.

Definition at line 65 of file AlgTool.cpp.

{
  return m_parent;
}

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

virtual

Query for a given interface.

Implements IInterface.

Reimplemented in extends2< AlgTool, IDODAlgMapper, IDODNodeMapper >, extends2< AlgTool, IDataStoreLeaves, IIncidentListener >, extends1< AlgTool, IDataStreamTool >, extends1< GaudiTool, IFuncMinimum >, extends1< AlgTool, IGslErrorHandler >, extends1< AlgTool, IFileAccess >, extends1< AlgTool, IPartitionControl >, and extends1< GaudiTool, IEqSolver >.

Definition at line 18 of file AlgTool.cpp.

{
  if ( 0 == ppvi ) { return StatusCode::FAILURE ; } // RETURN
  StatusCode sc = base_class::queryInterface(riid,ppvi);
  if (sc.isSuccess()) {
    return sc;
  }
  else {
    for ( InterfaceList::iterator it = m_interfaceList.begin() ;
          m_interfaceList.end() != it ; ++it )
    {
      if ( !it->first.versionMatch ( riid ) ) { continue ; }
      // OK
      *ppvi = it->second ;
      addRef() ;
      return SUCCESS ;     // RETURN
    }
    *ppvi = 0 ;
    return NO_INTERFACE ;  // RETURN
  }
  // cannot reach this point
}

StatusCode AlgTool::reinitialize ( )

virtual

Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).

Implements IAlgTool.

Definition at line 486 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::restart ( )

virtual

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Implements IAlgTool.

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

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

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 602 of file AlgTool.cpp.

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

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

private

implementation of service method

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

Definition at line 594 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.

Definition at line 72 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 151 of file AlgTool.cpp.

{
  if( m_svcLocator == 0) {
    return StatusCode::FAILURE;
  }
  SmartIF<IJobOptionsSvc> jos(m_svcLocator->service("JobOptionsSvc"));
  if( !jos.isValid() )  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 ( 0 != m_messageSvc )
  {
    if ( MSG::NIL != m_outputLevel )
    { m_messageSvc -> setOutputLevel ( name () , m_outputLevel ) ; }
    m_outputLevel = m_messageSvc -> outputLevel ( name () ) ;
  }

  return StatusCode::SUCCESS;
}

StatusCode AlgTool::setProperty ( const Property &  p )

virtual

Default implementations for IProperty interface.

Implements IProperty.

Definition at line 99 of file AlgTool.cpp.

{
  return m_propertyMgr->setProperty(p);
}

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

virtual

Set the property by string.

Implements IProperty.

Definition at line 106 of file AlgTool.cpp.

{
  return m_propertyMgr->setProperty(s);
}

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

virtual

Set the property by std::string.

Implements IProperty.

Definition at line 113 of file AlgTool.cpp.

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

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.

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

StatusCode AlgTool::start ( )

virtual

Start (from INITIALIZED to RUNNING).

Implements IAlgTool.

Definition at line 355 of file AlgTool.cpp.

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

StatusCode AlgTool::stop ( )

virtual

Stop (from RUNNING to INITIALIZED).

Implements IAlgTool.

Definition at line 397 of file AlgTool.cpp.

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

ISvcLocator* AlgTool::svcLoc ( ) const

inline

shortcut for the method service locator

Definition at line 160 of file AlgTool.h.

{ return serviceLocator() ; }

StatusCode AlgTool::sysFinalize ( )

virtual

Finalize AlgTool.

Implements IAlgTool.

Definition at line 405 of file AlgTool.cpp.

                                {
//-----------------------------------------------------------------------------

  try {
    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() : 0,
                                      IAuditor::Finalize);
    StatusCode sc = finalize();
    if (sc.isSuccess())
      m_state = m_targetState;
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught " << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
    log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught " << endmsg;
  }
  return StatusCode::FAILURE;

}

StatusCode AlgTool::sysInitialize ( )

virtual

Initialize AlgTool.

Implements IAlgTool.

Definition at line 277 of file AlgTool.cpp.

                                  {
//-----------------------------------------------------------------------------

  try {
    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() : 0,
                                      IAuditor::Initialize);
    StatusCode sc = initialize();
    if (sc.isSuccess())
      m_state = m_targetState;
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught " << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
    log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught " << endmsg;
  }
  return StatusCode::FAILURE ;

}

StatusCode AlgTool::sysReinitialize ( )

virtual

Initialize AlgTool.

Implements IAlgTool.

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

  try {
    Gaudi::Guards::AuditorGuard guard(this,
                                      // check if we want to audit the initialize
                                      (m_auditorReinitialize) ? auditorSvc() : 0,
                                      IAuditor::ReInitialize);
    StatusCode sc = reinitialize();
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught" << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
    log << MSG::FATAL << " Standard std::exception is caught" << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysReinitialize()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught" << endmsg;
  }
  return StatusCode::FAILURE ;

}

StatusCode AlgTool::sysRestart ( )

virtual

Start AlgTool.

Implements IAlgTool.

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

  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_auditorRestart) ? auditorSvc() : 0,
                                      IAuditor::ReStart);
    StatusCode sc = restart();
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysRestart()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught" << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysRestart()" );
    log << MSG::FATAL << " Standard std::exception is caught" << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysRestart()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught" << endmsg;
  }
  return StatusCode::FAILURE ;

}

StatusCode AlgTool::sysStart ( )

virtual

Start AlgTool.

Implements IAlgTool.

Definition at line 321 of file AlgTool.cpp.

                             {
//-----------------------------------------------------------------------------

  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() : 0,
                                      IAuditor::Start);
    StatusCode sc = start();
    if (sc.isSuccess())
      m_state = m_targetState;
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysStart()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught " << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysStart()" );
    log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysStart()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught " << endmsg;
  }
  return StatusCode::FAILURE ;

}

StatusCode AlgTool::sysStop ( )

virtual

Stop AlgTool.

Implements IAlgTool.

Definition at line 363 of file AlgTool.cpp.

                            {
//-----------------------------------------------------------------------------

  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() : 0,
                                      IAuditor::Stop);
    StatusCode sc = stop();
    if (sc.isSuccess())
      m_state = m_targetState;
    return sc;
  }
  catch( const GaudiException& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysStop()" );
    log << MSG::FATAL << " Exception with tag=" << Exception.tag()
        << " is caught " << endmsg;
    log << MSG::ERROR << Exception  << endmsg;
  }
  catch( const std::exception& Exception ) {
    MsgStream log ( msgSvc() , name() + ".sysStop()" );
    log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
    log << MSG::ERROR << Exception.what()  << endmsg;
  }
  catch( ... ) {
    MsgStream log ( msgSvc() , name() + ".sysStop()" );
    log << MSG::FATAL << "UNKNOWN Exception is caught " << endmsg;
  }
  return StatusCode::FAILURE ;

}

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

inlinevirtual

When we are in the middle of a transition, get the state where the transition is leading us.

Otherwise it returns the same state as state().

Implements IStateful.

Definition at line 66 of file AlgTool.h.

{ return m_targetState; }

virtual StatusCode AlgTool::terminate ( )

inlinevirtual

Initialization (from CONFIGURED to OFFLINE).

Implements IAlgTool.

Definition at line 62 of file AlgTool.h.

{ return StatusCode::SUCCESS; }

IToolSvc * AlgTool::toolSvc

(

)

const

The standard ToolSvc service, Return a pointer to the service if present.

Definition at line 86 of file AlgTool.cpp.

{
  if ( 0 == m_ptoolSvc ) {
    StatusCode sc = service( "ToolSvc", m_ptoolSvc, true );
    if( sc.isFailure() ) {
      throw GaudiException("Service [ToolSvc] not found", name(), sc);
    }
  }
  return m_ptoolSvc;
}

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

virtual

Retrieve type (concrete class) of the sub-algtool.

Implements IAlgTool.

Definition at line 58 of file AlgTool.cpp.

{
  return m_type;
}

Friends And Related Function Documentation

friend class ToolSvc

friend

Definition at line 35 of file AlgTool.h.

Member Data Documentation

BooleanProperty AlgTool::m_auditInit

private

Definition at line 348 of file AlgTool.h.

bool AlgTool::m_auditorFinalize

private

flag for auditors in "finalize()"

Definition at line 352 of file AlgTool.h.

bool AlgTool::m_auditorInitialize

private

flag for auditors in "initialize()"

Definition at line 349 of file AlgTool.h.

bool AlgTool::m_auditorReinitialize

private

flag for auditors in "reinitialize()"

Definition at line 353 of file AlgTool.h.

bool AlgTool::m_auditorRestart

private

flag for auditors in "restart()"

Definition at line 354 of file AlgTool.h.

bool AlgTool::m_auditorStart

private

flag for auditors in "start()"

Definition at line 350 of file AlgTool.h.

bool AlgTool::m_auditorStop

private

flag for auditors in "stop()"

Definition at line 351 of file AlgTool.h.

InterfaceList AlgTool::m_interfaceList

private

Interface list.

Definition at line 333 of file AlgTool.h.

IMessageSvc* AlgTool::m_messageSvc

mutableprivate

Message service.

Definition at line 328 of file AlgTool.h.

std::string AlgTool::m_monitorSvcName

private

Name to use for Monitor Service.

Definition at line 331 of file AlgTool.h.

const std::string AlgTool::m_name

private

AlgTool full name.

Definition at line 325 of file AlgTool.h.

IntegerProperty AlgTool::m_outputLevel

private

AlgTool output level.

Definition at line 323 of file AlgTool.h.

const IInterface* AlgTool::m_parent

private

AlgTool parent.

Definition at line 326 of file AlgTool.h.

IAuditorSvc* AlgTool::m_pAuditorSvc

mutableprivate

Auditor Service.

Definition at line 346 of file AlgTool.h.

IMonitorSvc* AlgTool::m_pMonitorSvc

mutableprivate

Online Monitoring Service.

Definition at line 330 of file AlgTool.h.

PropertyMgr* AlgTool::m_propertyMgr

private

Property Manager.

Definition at line 332 of file AlgTool.h.

IToolSvc* AlgTool::m_ptoolSvc

mutableprivate

Tool service.

Definition at line 329 of file AlgTool.h.

Gaudi::StateMachine::State AlgTool::m_state

private

state of the Tool

Definition at line 356 of file AlgTool.h.

ISvcLocator* AlgTool::m_svcLocator

mutableprivate

Pointer to Service Locator service.

Definition at line 327 of file AlgTool.h.

Gaudi::StateMachine::State AlgTool::m_targetState

private

state of the Tool

Definition at line 357 of file AlgTool.h.

std::string AlgTool::m_threadID

private

Thread Id for Alg Tool.

Definition at line 334 of file AlgTool.h.

std::string AlgTool::m_type

private

AlgTool type (concrete class name)

Definition at line 324 of file AlgTool.h.

---

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

• GaudiKernel/GaudiKernel/AlgTool.h
• GaudiKernel/src/Lib/AlgTool.cpp