Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

AlgorithmManager Class Reference

#include <AlgorithmManager.h>

Inheritance diagram for AlgorithmManager:

[legend]Collaboration diagram for AlgorithmManager:

[legend]List of all members.

---

Detailed Description

The AlgorithmManager class is in charge of the creation of concrete instances of Algorithms.

The ApplicationMgr delegates the creation and bookkeeping of algorithms to the algorithm factory. In order to be able to create algorithms from which it does not know the concrete type it requires that the algorithm has been declared in one of 3 possible ways: an abstract static creator function, a dynamic link library or an abstract factory reference.

Author:

Pere Mato

Definition at line 31 of file AlgorithmManager.h.

Public Types
typedef std::list< IAlgorithm * >	ListAlg
	typedefs and classes
Public Member Functions
	AlgorithmManager (IInterface *iface)
	default creator
virtual	~AlgorithmManager ()
	virtual destructor
virtual unsigned long	addRef ()
	implmentation of IInterface::addRef
virtual unsigned long	release ()
	implmentation of IInterface::release
virtual StatusCode	queryInterface (const InterfaceID &iid, void **pinterface)
	implementation of IInterface::queryInterface
virtual StatusCode	addAlgorithm (IAlgorithm *alg)
	implementation of IAlgManager::addAlgorithm
virtual StatusCode	removeAlgorithm (IAlgorithm *alg)
	implementation of IAlgManager::removeAlgorithm
virtual StatusCode	createAlgorithm (const std::string &algtype, const std::string &algname, IAlgorithm *&algorithm, bool managed=false)
	implementation of IAlgManager::createAlgorithm
virtual StatusCode	getAlgorithm (const std::string &name, IAlgorithm *&alg) const
	implementation of IAlgManager::getAlgorithm
virtual bool	existsAlgorithm (const std::string &name) const
	implementation of IAlgManager::existsAlgorithm
virtual std::list< IAlgorithm * > &	getAlgorithms () const
	implementation of IAlgManager::getAlgorithms
virtual StatusCode	initializeAlgorithms ()
	implementation of IAlgManager::initializeAlgorithms
virtual StatusCode	startAlgorithms ()
	implementation of IAlgManager::startAlgorithms
virtual StatusCode	stopAlgorithms ()
	implementation of IAlgManager::stopAlgorithms
virtual StatusCode	finalizeAlgorithms ()
	implementation of IAlgManager::finalizeAlgorithms
virtual StatusCode	reinitializeAlgorithms ()
	implementation of IAlgManager::initializeAlgorithms
virtual StatusCode	restartAlgorithms ()
	implementation of IAlgManager::startAlgorithms
Private Member Functions
IMessageSvc *	msgSvc ()
Private Attributes
IInterface *	m_pOuter
	Interface hub reference (ApplicationMgr).
unsigned long	m_refcount
	Reference counter.
ListAlg *	m_listalg
	List of algorithms maintained by AlgorithmManager.
ListAlg *	m_listmgralg
	List of managed algorithms maintained by AlgorithmManager.
ISvcLocator *	m_svclocator
	Service locator reference.
IMessageSvc *	m_msgsvc
	Pointer to the message service if it exists.
SmartIF< IStateful >	m_statemgr
	Pointer to the state machine.

---

Member Typedef Documentation

typedef std::list<IAlgorithm*> AlgorithmManager::ListAlg

typedefs and classes

Definition at line 34 of file AlgorithmManager.h.

---

Constructor & Destructor Documentation

AlgorithmManager::AlgorithmManager

(

IInterface *

iface

)

default creator

Definition at line 15 of file AlgorithmManager.cpp.

References StatusCode::ignore(), IID_ISvcLocator, m_listalg, m_listmgralg, m_msgsvc, m_pOuter, m_refcount, m_svclocator, and IInterface::queryInterface().

                                                   :
  m_statemgr(iface)
{
  m_pOuter = iface;
  m_pOuter->queryInterface(IID_ISvcLocator, pp_cast<void>(&m_svclocator)).ignore();
  m_msgsvc     = 0;
  m_refcount   = 1;
  m_listalg    = new ListAlg();
  m_listmgralg = new ListAlg();
}

AlgorithmManager::~AlgorithmManager

(

)

[virtual]

virtual destructor

Definition at line 27 of file AlgorithmManager.cpp.

References m_listalg, m_listmgralg, m_msgsvc, m_svclocator, and IInterface::release().

                                    {
  delete m_listalg;
  delete m_listmgralg;
  if( m_msgsvc ) m_msgsvc->release();
  if( m_svclocator ) m_svclocator->release();
}

---

Member Function Documentation

unsigned long AlgorithmManager::addRef

(

)

[virtual]

implmentation of IInterface::addRef

Implements IInterface.

Definition at line 35 of file AlgorithmManager.cpp.

References m_refcount.

Referenced by queryInterface().

                                       {
  m_refcount++;
  return m_refcount;
}

unsigned long AlgorithmManager::release

(

)

[virtual]

implmentation of IInterface::release

Implements IInterface.

Definition at line 41 of file AlgorithmManager.cpp.

References count(), and m_refcount.

Referenced by ApplicationMgr::~ApplicationMgr().

                                        {
  unsigned long count = --m_refcount;
  if( count <= 0) {
    delete this;
  }
  return count;
}

StatusCode AlgorithmManager::queryInterface	(	const InterfaceID &	iid,
		void **	pinterface
	)			[virtual]

implementation of IInterface::queryInterface

Implements IInterface.

Definition at line 50 of file AlgorithmManager.cpp.

References addRef(), IID_IAlgManager, IID_IInterface, m_pOuter, IInterface::queryInterface(), and StatusCode::SUCCESS.

                                                                                     {
  if( iid == IID_IInterface ) {  
    *pinterface = (IInterface*)this;
    addRef();
    return StatusCode::SUCCESS;
  } 
  else if ( iid == IID_IAlgManager ) {
    *pinterface = (IAlgManager*)this;
    addRef();
    return StatusCode::SUCCESS;
  } 
  else {
    return m_pOuter->queryInterface(iid, pinterface);
  }
  return StatusCode::SUCCESS;
}

StatusCode AlgorithmManager::addAlgorithm

(

IAlgorithm *

alg

)

[virtual]

implementation of IAlgManager::addAlgorithm

Implements IAlgManager.

Definition at line 68 of file AlgorithmManager.cpp.

References m_listalg, std::list< _Tp, _Alloc >::push_back(), and StatusCode::SUCCESS.

                                                           {
  m_listalg->push_back( alg );
  return StatusCode::SUCCESS;
}

StatusCode AlgorithmManager::removeAlgorithm

(

IAlgorithm *

alg

)

[virtual]

implementation of IAlgManager::removeAlgorithm

Implements IAlgManager.

Definition at line 74 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), std::list< _Tp, _Alloc >::erase(), m_listalg, and StatusCode::SUCCESS.

                                                              {
  ListAlg::iterator it;
  for (it = m_listalg->begin(); it != m_listalg->end(); it++ ) {
    if( *it == alg ) {
      m_listalg->erase(it);
      break;
    }
  }
  return StatusCode::SUCCESS;
}

StatusCode AlgorithmManager::createAlgorithm	(	const std::string &	algtype,
		const std::string &	algname,
		IAlgorithm *&	algorithm,
		bool	managed = false
	)			[virtual]

implementation of IAlgManager::createAlgorithm

Implements IAlgManager.

Definition at line 86 of file AlgorithmManager.cpp.

References IInterface::addRef(), endmsg(), endreq(), MSG::ERROR, existsAlgorithm(), StatusCode::FAILURE, MSG::FATAL, Gaudi::StateMachine::INITIALIZED, StatusCode::isSuccess(), isValidInterface(), m_listalg, m_listmgralg, m_statemgr, m_svclocator, msgSvc(), std::list< _Tp, _Alloc >::push_back(), Gaudi::StateMachine::RUNNING, IAlgorithm::sysInitialize(), and IAlgorithm::sysStart().

{
  MsgStream log(msgSvc(), "AlgorithmManager");
  // Check is the algorithm is already existing
  if( existsAlgorithm( algname ) ) {
    // return an error because an algorithm with that name already exists
    return StatusCode::FAILURE;
  }
  algorithm = PluginService::Create<IAlgorithm*>(algtype, algname, m_svclocator);
  if ( algorithm ) {
    // Check the compatibility of the version of the interface obtained
    if( !isValidInterface(algorithm) ) {
      log << MSG::FATAL << "Incompatible interface IAlgorithm version for " << algtype << endreq;
      return StatusCode::FAILURE;
    }
    StatusCode rc;
    m_listalg->push_back( algorithm );
    if ( managed ) {
      algorithm->addRef();
      m_listmgralg->push_back( algorithm );

      // Bring the created service to the same state of the ApplicationMgr
      if (m_statemgr->FSMState() >= Gaudi::StateMachine::INITIALIZED) {
        rc = algorithm->sysInitialize();
        if (rc.isSuccess() && m_statemgr->FSMState() >= Gaudi::StateMachine::RUNNING) {
          rc = algorithm->sysStart();
        }
      }
      if ( !rc.isSuccess() )  {
        log << MSG::ERROR << "Failed to initialize algorithm: "
            << "[" << algname << "]" << endmsg;
      }
    }
    return rc;
  }
  log << MSG::ERROR << "Algorithm of type " << algtype 
      << " is unknown (No factory available)." << endmsg;
  return StatusCode::FAILURE;
}

StatusCode AlgorithmManager::getAlgorithm	(	const std::string &	name,
		IAlgorithm *&	alg
	)			const [virtual]

implementation of IAlgManager::getAlgorithm

Implements IAlgManager.

Definition at line 130 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), StatusCode::FAILURE, m_listalg, name, and StatusCode::SUCCESS.

                                                                                        {
  ListAlg::const_iterator it;
  for (it = m_listalg->begin(); it != m_listalg->end(); it++ ) {
    if( (*it)->name() == name ) {
      alg = *it;
      return StatusCode::SUCCESS;
    }
  }
  return StatusCode::FAILURE;
}

bool AlgorithmManager::existsAlgorithm

(

const std::string &

name

)

const [virtual]

implementation of IAlgManager::existsAlgorithm

Implements IAlgManager.

Definition at line 142 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), m_listalg, and name.

Referenced by createAlgorithm().

                                                                    {
  ListAlg::const_iterator it;
  for (it = m_listalg->begin(); it != m_listalg->end(); it++ ) {
    if( (*it)->name() == name ) {
      return true;
    }
  }
  return false;
}

std::list< IAlgorithm * > & AlgorithmManager::getAlgorithms

(

)

const [virtual]

implementation of IAlgManager::getAlgorithms

Implements IAlgManager.

Definition at line 153 of file AlgorithmManager.cpp.

References m_listalg.

{
  return *m_listalg;
}

StatusCode AlgorithmManager::initializeAlgorithms

(

)

[virtual]

implementation of IAlgManager::initializeAlgorithms

Implements IAlgManager.

Definition at line 158 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), StatusCode::isFailure(), and m_listmgralg.

                                                  {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysInitialize();
    if ( rc.isFailure() ) return rc; 
  }
  return rc;
}

StatusCode AlgorithmManager::startAlgorithms

(

)

[virtual]

implementation of IAlgManager::startAlgorithms

Implements IAlgManager.

Definition at line 168 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), StatusCode::isFailure(), and m_listmgralg.

                                             {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysStart();
    if ( rc.isFailure() ) return rc; 
  }
  return rc;
}

StatusCode AlgorithmManager::stopAlgorithms

(

)

[virtual]

implementation of IAlgManager::stopAlgorithms

Implements IAlgManager.

Definition at line 178 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), StatusCode::isFailure(), and m_listmgralg.

Referenced by ApplicationMgr::stop().

                                            {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysStop();
    if ( rc.isFailure() ) return rc; 
  }
  return rc;
}

StatusCode AlgorithmManager::finalizeAlgorithms

(

)

[virtual]

implementation of IAlgManager::finalizeAlgorithms

Implements IAlgManager.

Definition at line 188 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::clear(), std::list< _Tp, _Alloc >::end(), StatusCode::isFailure(), and m_listmgralg.

Referenced by ApplicationMgr::finalize().

                                                {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysFinalize();
    if( rc.isFailure() ) return rc;
    (*it)->release();
  }
  m_listmgralg->clear();
  return rc;
}

StatusCode AlgorithmManager::reinitializeAlgorithms

(

)

[virtual]

implementation of IAlgManager::initializeAlgorithms

Implements IAlgManager.

Definition at line 200 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), endreq(), MSG::ERROR, StatusCode::isFailure(), m_listmgralg, and msgSvc().

Referenced by ApplicationMgr::reinitialize().

                                                    {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysReinitialize();
    if( rc.isFailure() ){
      MsgStream log(msgSvc(), "AlgorithmManager");
      log << MSG::ERROR << "Unable to re-initialize Service: " << (*it)->name() << endreq;
      return rc;
    }
  }
  return rc;
}

StatusCode AlgorithmManager::restartAlgorithms

(

)

[virtual]

implementation of IAlgManager::startAlgorithms

Implements IAlgManager.

Definition at line 214 of file AlgorithmManager.cpp.

References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), endreq(), MSG::ERROR, StatusCode::isFailure(), m_listmgralg, and msgSvc().

Referenced by ApplicationMgr::restart().

                                               {
  StatusCode rc;
  ListAlg::const_iterator it;
  for (it = m_listmgralg->begin(); it != m_listmgralg->end(); it++ ) {
    rc = (*it)->sysRestart();
    if( rc.isFailure() ){
      MsgStream log(msgSvc(), "AlgorithmManager");
      log << MSG::ERROR << "Unable to re-initialize Service: " << (*it)->name() << endreq;
      return rc;
    }
  }
  return rc;
}

IMessageSvc * AlgorithmManager::msgSvc

(

)

[private]

Definition at line 229 of file AlgorithmManager.cpp.

References ISvcLocator::getService(), StatusCode::ignore(), IID_IMessageSvc, m_msgsvc, and m_svclocator.

Referenced by createAlgorithm(), reinitializeAlgorithms(), and restartAlgorithms().

                                     {
  // Access the message service if not yet done already
  if( m_msgsvc == 0 ) {
    m_svclocator->getService( "MessageSvc", IID_IMessageSvc,
                              *pp_cast<IInterface>(&m_msgsvc) ).ignore();
  }
  return m_msgsvc;
}

---

Member Data Documentation

IInterface* AlgorithmManager::m_pOuter [private]

Interface hub reference (ApplicationMgr).

Definition at line 78 of file AlgorithmManager.h.

Referenced by AlgorithmManager(), and queryInterface().

unsigned long AlgorithmManager::m_refcount [private]

Reference counter.

Definition at line 79 of file AlgorithmManager.h.

Referenced by addRef(), AlgorithmManager(), and release().

ListAlg* AlgorithmManager::m_listalg [private]

List of algorithms maintained by AlgorithmManager.

Definition at line 80 of file AlgorithmManager.h.

Referenced by addAlgorithm(), AlgorithmManager(), createAlgorithm(), existsAlgorithm(), getAlgorithm(), getAlgorithms(), removeAlgorithm(), and ~AlgorithmManager().

ListAlg* AlgorithmManager::m_listmgralg [private]

List of managed algorithms maintained by AlgorithmManager.

Definition at line 81 of file AlgorithmManager.h.

Referenced by AlgorithmManager(), createAlgorithm(), finalizeAlgorithms(), initializeAlgorithms(), reinitializeAlgorithms(), restartAlgorithms(), startAlgorithms(), stopAlgorithms(), and ~AlgorithmManager().

ISvcLocator* AlgorithmManager::m_svclocator [private]

Service locator reference.

Definition at line 82 of file AlgorithmManager.h.

Referenced by AlgorithmManager(), createAlgorithm(), msgSvc(), and ~AlgorithmManager().

IMessageSvc* AlgorithmManager::m_msgsvc [private]

Pointer to the message service if it exists.

Definition at line 83 of file AlgorithmManager.h.

Referenced by AlgorithmManager(), msgSvc(), and ~AlgorithmManager().

SmartIF<IStateful> AlgorithmManager::m_statemgr [private]

Pointer to the state machine.

Definition at line 84 of file AlgorithmManager.h.

Referenced by createAlgorithm().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/ApplicationMgr/AlgorithmManager.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/ApplicationMgr/AlgorithmManager.cpp

---