Base class for a component manager. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/ComponentManager.h>

Inheritance diagram for ComponentManager:

[legend]

Collaboration diagram for ComponentManager:

[legend]

Public Member Functions
	ComponentManager (IInterface *application, const InterfaceID &baseIID)
	Constructor.

const InterfaceID &	componentBaseInterface () const override
	Basic interface id of the managed components.

StatusCode	queryInterface (const InterfaceID &iid, void **pinterface) override
	Specialized queryInterface implementation.

void const *	i_cast (const InterfaceID &iid) const override
	Specialized i_cast implementation.

SmartIF< ISvcLocator > &	serviceLocator () const override

StatusCode	configure () override
	Configuration (from OFFLINE to CONFIGURED).

StatusCode	initialize () override
	Initialization (from CONFIGURED to INITIALIZED).

StatusCode	start () override
	Start (from INITIALIZED to RUNNING).

StatusCode	stop () override
	Stop (from RUNNING to INITIALIZED).

StatusCode	finalize () override
	Finalize (from INITIALIZED to CONFIGURED).

StatusCode	terminate () override
	Initialization (from CONFIGURED to OFFLINE).

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

StatusCode	restart () override
	Initialization (from RUNNING to RUNNING, via INITIALIZED).

Gaudi::StateMachine::State	FSMState () const override
	Get the current state.

Gaudi::StateMachine::State	targetFSMState () const override
	When we are in the middle of a transition, get the state where the transition is leading us.

Public Member Functions inherited from CommonMessaging< implements< IComponentManager > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

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

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

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

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

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

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

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

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

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Protected Attributes
SmartIF< IInterface >	m_application
	Pointer to the owner of the manager.

SmartIF< IStateful >	m_stateful
	Pointer to the IStateful interface of the owner.

InterfaceID	m_basicInterfaceId
	Basic interface id of the managed components.

SmartIF< ISvcLocator >	m_svcLocator
	Service locator (needed to access the MessageSvc)

friend	ApplicationMgr

Additional Inherited Members
Public Types inherited from CommonMessaging< implements< IComponentManager > >
using	base_class

Protected Member Functions inherited from CommonMessaging< implements< IComponentManager > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

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

Detailed Description

Base class for a component manager.

Author: Marco Clemencic

Definition at line 24 of file ComponentManager.h.

Constructor & Destructor Documentation

◆ ComponentManager()

ComponentManager::ComponentManager	(	IInterface *	application,
		const InterfaceID &	baseIID )

Constructor.

Parameters

application the manager of managers

Definition at line 22 of file ComponentManager.cpp.

23 : m_application( application ), m_stateful( application ), m_basicInterfaceId( baseIID ) {}

ComponentManager::m_basicInterfaceId

InterfaceID m_basicInterfaceId

Basic interface id of the managed components.

Definition ComponentManager.h:86

ComponentManager::m_stateful

SmartIF< IStateful > m_stateful

Pointer to the IStateful interface of the owner.

Definition ComponentManager.h:83

ComponentManager::m_application

SmartIF< IInterface > m_application

Pointer to the owner of the manager.

Definition ComponentManager.h:80

Member Function Documentation

◆ componentBaseInterface()

const InterfaceID & ComponentManager::componentBaseInterface ( ) const

override

Basic interface id of the managed components.

Definition at line 27 of file ComponentManager.cpp.

27{ return m_basicInterfaceId; }

◆ configure()

StatusCode ComponentManager::configure ( )

inlineoverride

Configuration (from OFFLINE to CONFIGURED).

Definition at line 48 of file ComponentManager.h.

48{ return StatusCode::SUCCESS; }

StatusCode::SUCCESS

constexpr static const auto SUCCESS

Definition StatusCode.h:99

◆ finalize()

StatusCode ComponentManager::finalize ( )

inlineoverride

Finalize (from INITIALIZED to CONFIGURED).

Definition at line 60 of file ComponentManager.h.

60{ return StatusCode::SUCCESS; }

◆ FSMState()

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

inlineoverride

Get the current state.

Definition at line 72 of file ComponentManager.h.

72{ return m_stateful->FSMState(); }

◆ i_cast()

void const * ComponentManager::i_cast ( const InterfaceID & iid ) const

override

Specialized i_cast implementation.

If an interface is not found in the implemented ones, we fall back on the owner.

Definition at line 38 of file ComponentManager.cpp.

                                                                   {
  // try local interfaces
  if ( auto output = base_class::i_cast( iid ); output ) { return output; }
  // fall back on the owner, if local interface didn't match...
  return m_application->i_cast( iid );
}

◆ initialize()

StatusCode ComponentManager::initialize ( )

inlineoverride

Initialization (from CONFIGURED to INITIALIZED).

Definition at line 51 of file ComponentManager.h.

51{ return StatusCode::SUCCESS; }

◆ queryInterface()

StatusCode ComponentManager::queryInterface	(	const InterfaceID &	iid,
		void **	pinterface )

override

Specialized queryInterface implementation.

If an interface is not found in the implemented ones, we fall back on the owner.

Definition at line 31 of file ComponentManager.cpp.

                                                                                       {
  // try local interfaces
  StatusCode sc = base_class::queryInterface( iid, pinterface );
  // fall back on the owner, if local interface didn't match...
  return sc.isSuccess() ? sc : m_application->queryInterface( iid, pinterface );
}

◆ reinitialize()

StatusCode ComponentManager::reinitialize ( )

inlineoverride

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

Definition at line 66 of file ComponentManager.h.

66{ return StatusCode::SUCCESS; }

◆ restart()

StatusCode ComponentManager::restart ( )

inlineoverride

Initialization (from RUNNING to RUNNING, via INITIALIZED).

Definition at line 69 of file ComponentManager.h.

69{ return StatusCode::SUCCESS; }

◆ serviceLocator()

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

inlineoverride

Definition at line 42 of file ComponentManager.h.

                                                        {
    if ( !m_svcLocator ) m_svcLocator = m_application;
    return m_svcLocator;
  }

◆ start()

StatusCode ComponentManager::start ( )

inlineoverride

Start (from INITIALIZED to RUNNING).

Definition at line 54 of file ComponentManager.h.

54{ return StatusCode::SUCCESS; }

◆ stop()

StatusCode ComponentManager::stop ( )

inlineoverride

Stop (from RUNNING to INITIALIZED).

Definition at line 57 of file ComponentManager.h.

57{ return StatusCode::SUCCESS; }

◆ targetFSMState()

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

inlineoverride

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

Definition at line 76 of file ComponentManager.h.

76{ return m_stateful->targetFSMState(); }

◆ terminate()

StatusCode ComponentManager::terminate ( )

inlineoverride

Initialization (from CONFIGURED to OFFLINE).

Definition at line 63 of file ComponentManager.h.

63{ return StatusCode::SUCCESS; }

Member Data Documentation

◆ ApplicationMgr

friend ComponentManager::ApplicationMgr

protected

Definition at line 91 of file ComponentManager.h.

◆ m_application

SmartIF<IInterface> ComponentManager::m_application

protected

Pointer to the owner of the manager.

Definition at line 80 of file ComponentManager.h.

◆ m_basicInterfaceId

InterfaceID ComponentManager::m_basicInterfaceId

protected

Basic interface id of the managed components.

Definition at line 86 of file ComponentManager.h.

◆ m_stateful

SmartIF<IStateful> ComponentManager::m_stateful

protected

Pointer to the IStateful interface of the owner.

Definition at line 83 of file ComponentManager.h.

◆ m_svcLocator

SmartIF<ISvcLocator> ComponentManager::m_svcLocator

mutableprotected

Service locator (needed to access the MessageSvc)

Definition at line 89 of file ComponentManager.h.

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

GaudiKernel/include/GaudiKernel/ComponentManager.h
GaudiKernel/src/Lib/ComponentManager.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComponentManager()

Member Function Documentation

◆ componentBaseInterface()

◆ configure()

◆ finalize()

◆ FSMState()

◆ i_cast()

◆ initialize()

◆ queryInterface()

◆ reinitialize()

◆ restart()

◆ serviceLocator()

◆ start()

◆ stop()

◆ targetFSMState()

◆ terminate()

Member Data Documentation

◆ ApplicationMgr

◆ m_application

◆ m_basicInterfaceId

◆ m_stateful

◆ m_svcLocator