Inheritance diagram for PartitionSwitchTool:

[legend]

Collaboration diagram for PartitionSwitchTool:

[legend]

Public Member Functions
STATUS	initialize () override
	Initialize.

STATUS	finalize () override
	Finalize.

void	_check (STATUS sc, CSTR msg) const

STATUS	create (CSTR nam, CSTR typ) override
	Create a partition object. The name identifies the partition uniquely.

STATUS	create (CSTR nam, CSTR typ, IInterface *&pPartition) override
	Create a partition object. The name identifies the partition uniquely.

STATUS	drop (CSTR nam) override
	Drop a partition object. The name identifies the partition uniquely.

STATUS	drop (IInterface *pPartition) override
	Drop a partition object. The name identifies the partition uniquely.

STATUS	activate (CSTR nam) override
	Activate a partition object. The name identifies the partition uniquely.

STATUS	activate (IInterface *pPartition) override
	Activate a partition object.

STATUS	get (CSTR nam, IInterface *&pPartition) const override
	Access a partition object. The name identifies the partition uniquely.

STATUS	activePartition (std::string &nam, IInterface *&pPartition) const override
	Access the active partition object.

Public Member Functions inherited from extends< AlgTool, IPartitionControl >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from AlgTool
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface.

void const *	i_cast (const InterfaceID &riid) const override

const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object.

const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool.

const IInterface *	parent () const override
	Retrieve parent of the sub-algtool.

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

StatusCode	reinitialize () override

StatusCode	restart () override

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

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

StatusCode	sysInitialize () override
	Initialize AlgTool.

StatusCode	sysStart () override
	Start AlgTool.

StatusCode	sysStop () override
	Stop AlgTool.

StatusCode	sysFinalize () override
	Finalize AlgTool.

StatusCode	sysReinitialize () override
	Initialize AlgTool.

StatusCode	sysRestart () override
	Start AlgTool.

	AlgTool (std::string type, std::string name, const IInterface *parent)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

ISvcLocator *	svcLoc () const
	shortcut for the method service locator

IDataProviderSvc *	evtSvc () const
	accessor to event service service

IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present.

SmartIF< IService >	service (std::string_view 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 >	service (std::string_view name, const bool createIf=true, const bool quiet=false) const

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

void	acceptDHVisitor (IDataHandleVisitor *) const override

void	registerTool (IAlgTool *tool) const

void	deregisterTool (IAlgTool *tool) const

const std::vector< IAlgTool * > &	tools () const

IAuditorSvc *	auditorSvc () const
	Access the auditor service.

IMonitorSvc *	monitorSvc () const
	Access the monitor service.

template<class T>
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information.

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)

	~AlgTool () override

Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override

std::vector< Gaudi::DataHandle * >	outputHandles () const override

virtual const DataObjIDColl &	extraInputDeps () const override

virtual const DataObjIDColl &	extraOutputDeps () const override

void	declare (Gaudi::DataHandle &handle) override

void	renounce (Gaudi::DataHandle &handle) override

bool	renounceInput (const DataObjID &id) override

const DataObjIDColl &	inputDataObjs () const override

const DataObjIDColl &	outputDataObjs () const override

void	addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override

Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
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)

Private Types
using	CSTR = const std::string&

using	STATUS = StatusCode

Private Attributes
Gaudi::Property< std::string >	m_actorName { this, "Actor", "EventDataService", "option to set the multi-service name" }

SmartIF< IPartitionControl >	m_actor
	reference to Partition Controller

Additional Inherited Members
Public Types inherited from extends< AlgTool, IPartitionControl >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from AlgTool
using	Factory = Gaudi::PluginService::Factory<IAlgTool( const std::string&, const std::string&, const IInterface )>

Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from AlgTool
template<typename I>
void	declareInterface (I *i)

std::vector< IAlgTool * > &	tools ()

Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this

Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
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.

Protected Attributes inherited from AlgTool
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles.

Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl	m_inputDataObjs

DataObjIDColl	m_outputDataObjs

Detailed Description

Author: Markus Frank

Date: 2004-06-24

Definition at line 22 of file PartitionSwitchTool.cpp.

Member Typedef Documentation

◆ CSTR

using PartitionSwitchTool::CSTR = const std::string&

private

Definition at line 24 of file PartitionSwitchTool.cpp.

◆ STATUS

using PartitionSwitchTool::STATUS = StatusCode

private

Definition at line 25 of file PartitionSwitchTool.cpp.

Member Function Documentation

◆ _check()

void PartitionSwitchTool::_check	(	STATUS	sc,
		CSTR	msg ) const

inline

Definition at line 56 of file PartitionSwitchTool.cpp.

56{ error() << msg << " Status=" << sc.getCode() << endmsg; }

endmsg

MsgStream & endmsg(MsgStream &s)

MsgStream Modifier: endmsg. Calls the output method of the MsgStream.

Definition MsgStream.h:198

CommonMessagingBase::error

MsgStream & error() const

shortcut for the method msgStream(MSG::ERROR)

Definition CommonMessaging.h:107

CommonMessagingBase::msg

MsgStream & msg() const

shortcut for the method msgStream(MSG::INFO)

Definition CommonMessaging.h:122

◆ activate() [1/2]

STATUS PartitionSwitchTool::activate ( CSTR nam )

inlineoverride

Activate a partition object. The name identifies the partition uniquely.

Definition at line 82 of file PartitionSwitchTool.cpp.

                                       {
    STATUS sc = m_actor ? m_actor->activate( nam ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot activate partition: " + nam );
  }

◆ activate() [2/2]

STATUS PartitionSwitchTool::activate ( IInterface * pPartition )

inlineoverride

Activate a partition object.

Definition at line 87 of file PartitionSwitchTool.cpp.

                                                     {
    STATUS sc = m_actor ? m_actor->activate( pPartition ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot activate partition by Interface." );
  }

◆ activePartition()

STATUS PartitionSwitchTool::activePartition	(	std::string &	nam,
		IInterface *&	pPartition ) const

inlineoverride

Access the active partition object.

Definition at line 97 of file PartitionSwitchTool.cpp.

                                                                                   {
    STATUS sc = m_actor ? m_actor->activePartition( nam, pPartition ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot determine active partition." );
  }

◆ create() [1/2]

STATUS PartitionSwitchTool::create	(	CSTR	nam,
		CSTR	typ )

inlineoverride

Create a partition object. The name identifies the partition uniquely.

Definition at line 62 of file PartitionSwitchTool.cpp.

                                               {
    STATUS sc = m_actor ? m_actor->create( nam, typ ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot create partition: " + nam + " of type " + typ );
  }

◆ create() [2/2]

STATUS PartitionSwitchTool::create	(	CSTR	nam,
		CSTR	typ,
		IInterface *&	pPartition )

inlineoverride

Create a partition object. The name identifies the partition uniquely.

Definition at line 67 of file PartitionSwitchTool.cpp.

                                                                        {
    STATUS sc = m_actor ? m_actor->create( nam, typ, pPartition ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot create partition: " + nam + " of type " + typ );
  }

◆ drop() [1/2]

STATUS PartitionSwitchTool::drop ( CSTR nam )

inlineoverride

Drop a partition object. The name identifies the partition uniquely.

Definition at line 72 of file PartitionSwitchTool.cpp.

                                   {
    STATUS sc = m_actor ? m_actor->drop( nam ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot drop partition: " + nam );
  }

◆ drop() [2/2]

STATUS PartitionSwitchTool::drop ( IInterface * pPartition )

inlineoverride

Drop a partition object. The name identifies the partition uniquely.

Definition at line 77 of file PartitionSwitchTool.cpp.

                                                 {
    STATUS sc = m_actor ? m_actor->drop( pPartition ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot drop partition by Interface." );
  }

◆ finalize()

STATUS PartitionSwitchTool::finalize ( )

inlineoverride

Finalize.

Definition at line 51 of file PartitionSwitchTool.cpp.

                             {
    m_actor = nullptr;
    return AlgTool::finalize();
  }

◆ get()

STATUS PartitionSwitchTool::get	(	CSTR	nam,
		IInterface *&	pPartition ) const

inlineoverride

Access a partition object. The name identifies the partition uniquely.

Definition at line 92 of file PartitionSwitchTool.cpp.

                                                                 {
    STATUS sc = m_actor ? m_actor->get( nam, pPartition ) : IInterface::Status::NO_INTERFACE;
    CHECK( sc, "Cannot get partition " + nam );
  }

◆ initialize()

STATUS PartitionSwitchTool::initialize ( )

inlineoverride

Initialize.

Access partitioned multi-service

Definition at line 36 of file PartitionSwitchTool.cpp.

                               {
    STATUS sc = AlgTool::initialize();
    if ( !sc.isSuccess() ) {
      error() << "Cannot initialize base class!" << endmsg;
      return sc;
    }
    m_actor = service<IPartitionControl>( m_actorName );
    if ( !m_actor ) {
      error() << "Cannot retrieve partition controller \"" << m_actorName.value() << "\"!" << endmsg;
      return StatusCode::FAILURE;
    }
    return sc;
  }

Member Data Documentation

◆ m_actor

SmartIF<IPartitionControl> PartitionSwitchTool::m_actor

private

reference to Partition Controller

Definition at line 30 of file PartitionSwitchTool.cpp.

◆ m_actorName

Gaudi::Property<std::string> PartitionSwitchTool::m_actorName { this, "Actor", "EventDataService", "option to set the multi-service name" }

private

Definition at line 28 of file PartitionSwitchTool.cpp.

28{ this, "Actor", "EventDataService", "option to set the multi-service name" };

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

GaudiCommonSvc/src/DataSvc/PartitionSwitchTool.cpp

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CSTR

◆ STATUS

Member Function Documentation

◆ _check()

◆ activate() [1/2]

◆ activate() [2/2]

◆ activePartition()

◆ create() [1/2]

◆ create() [2/2]

◆ drop() [1/2]

◆ drop() [2/2]

◆ finalize()

◆ get()

◆ initialize()

Member Data Documentation

◆ m_actor

◆ m_actorName