Small algorithm which switches the partition of a configurable multi-service. More...

Inheritance diagram for PartitionSwitchAlg:

Collaboration diagram for PartitionSwitchAlg:

Public Member Functions
	PartitionSwitchAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Standard algorithm constructor. More...

	~PartitionSwitchAlg () override=default
	Standard Destructor. More...

STATUS	initialize () override
	Initialize. More...

STATUS	finalize () override
	Finalize. More...

STATUS	execute () override
	Execute procedure. More...

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

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

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

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

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

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

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

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

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

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

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

	~extends () override=default
	Virtual destructor. More...

void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

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

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

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

	~extend_interfaces () override=default
	Virtual destructor. More...

Private Types
using	STATUS = StatusCode

using	CSTR = const std::string &

Private Member Functions
StatusCode	log_ (StatusCode sc, const std::string &msg) const

template<typename... FArgs, typename... Args>
StatusCode	fwd_ (StatusCode(IPartitionControl::*fun)(FArgs...), Args &&...args)

template<typename... FArgs, typename... Args>
StatusCode	fwd_ (StatusCode(IPartitionControl::*fun)(FArgs...) const, Args &&...args) const

Private Attributes
std::string	m_partName
	Job option to set the requested partition name. More...

std::string	m_toolType
	Job option to set the tool manipulating the multi-service name. More...

IPartitionControl *	m_actor = nullptr
	reference to Partition Controller More...

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Small algorithm which switches the partition of a configurable multi-service.

The algorithm can be part of a sequence, which allows for e.g. buffer tampering.

Author: : M.Frank

Version: : 1.0

Definition at line 25 of file PartitionSwitchAlg.cpp.

Member Typedef Documentation

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

private

Definition at line 28 of file PartitionSwitchAlg.cpp.

using PartitionSwitchAlg::STATUS = StatusCode

private

Definition at line 27 of file PartitionSwitchAlg.cpp.

Constructor & Destructor Documentation

PartitionSwitchAlg::PartitionSwitchAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

inline

Standard algorithm constructor.

Definition at line 42 of file PartitionSwitchAlg.cpp.

   : base_class(name, pSvcLocator)
   {
     declareProperty("Partition",  m_partName);
     declareProperty("Tool",       m_toolType="PartitionSwitchTool");
   }

PartitionSwitchAlg::~PartitionSwitchAlg ( )

overridedefault

Standard Destructor.

Member Function Documentation

STATUS PartitionSwitchAlg::activate ( CSTR nam )

inlineoverride

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

Definition at line 133 of file PartitionSwitchAlg.cpp.

                                       {
     auto sc = fwd_<CSTR>(&IPartitionControl::activate,nam);
     return sc.isSuccess() ? sc : log_(sc, "Cannot activate partition: "+nam);
   }

STATUS PartitionSwitchAlg::activate ( IInterface * pPartition )

inlineoverride

Activate a partition object.

Definition at line 138 of file PartitionSwitchAlg.cpp.

                                                     {
     auto sc = fwd_<IInterface*>(&IPartitionControl::activate, pPartition);
     return sc.isSuccess() ? sc : log_(sc, "Cannot activate partition by Interface.");
   }

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

inlineoverride

Access the active partition object.

Definition at line 148 of file PartitionSwitchAlg.cpp.

                                                                                  {
     auto sc = fwd_<std::string&,IInterface*&>(&IPartitionControl::activePartition,nam,pPartition);
     return sc.isSuccess() ? sc : log_(sc, "Cannot determine active partition.");
   }

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

inlineoverride

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

Definition at line 113 of file PartitionSwitchAlg.cpp.

                                               {
     auto sc = fwd_<CSTR,CSTR>(&IPartitionControl::create,nam,typ);
     return sc.isSuccess() ? sc : log_(sc, "Cannot create partition: "+nam+" of type "+typ);
   }

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

inlineoverride

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

Definition at line 118 of file PartitionSwitchAlg.cpp.

                                                                        {
     auto sc = fwd_<CSTR,CSTR,IInterface*&>(&IPartitionControl::create,nam,typ,pPartition);
     return sc.isSuccess() ? sc : log_(sc, "Cannot create partition: "+nam+" of type "+typ);
   }

STATUS PartitionSwitchAlg::drop ( CSTR nam )

inlineoverride

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

Definition at line 123 of file PartitionSwitchAlg.cpp.

                                   {
     auto sc = fwd_<CSTR>(&IPartitionControl::drop,nam);
     return  sc.isSuccess() ? sc : log_(sc, "Cannot drop partition: "+nam);
   }

STATUS PartitionSwitchAlg::drop ( IInterface * pPartition )

inlineoverride

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

Definition at line 128 of file PartitionSwitchAlg.cpp.

                                                 {
     auto sc = fwd_<IInterface*>(&IPartitionControl::drop,pPartition);
     return sc.isSuccess() ? sc : log_(sc, "Cannot drop partition by Interface.");
   }

STATUS PartitionSwitchAlg::execute ( )

inlineoverride

Execute procedure.

Definition at line 82 of file PartitionSwitchAlg.cpp.

                              {
     if ( m_actor )  {
       STATUS sc = m_actor->activate(m_partName);
       if ( !sc.isSuccess() )  {
         MsgStream log(msgSvc(), name());
         log << MSG::ERROR << "Cannot activate partition \""
             << m_partName << "\"!" << endmsg;
       }
       return sc;
     }
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << "The partition control tool \"" << name()
         << "." << m_toolType << "\" cannot be accessed!" << endmsg;
     return STATUS::FAILURE;
   }

STATUS PartitionSwitchAlg::finalize ( )

inlineoverride

Finalize.

Definition at line 74 of file PartitionSwitchAlg.cpp.

                               {
     SmartIF<IAlgTool> tool(m_actor);
     if ( tool ) toolSvc()->releaseTool(tool);
     m_actor = nullptr;
     return STATUS::SUCCESS;
   }

template<typename... FArgs, typename... Args>

StatusCode PartitionSwitchAlg::fwd_	(	StatusCode(IPartitionControl::*)(FArgs...)	fun,
		Args &&...	args
	)

inlineprivate

Definition at line 104 of file PartitionSwitchAlg.cpp.

                                                                                 {
        return m_actor ? (m_actor->*fun)(std::forward<Args>(args)...) : NO_INTERFACE;
   }

template<typename... FArgs, typename... Args>

StatusCode PartitionSwitchAlg::fwd_	(	StatusCode(IPartitionControl::*)(FArgs...) const	fun,
		Args &&...	args
	)		const

inlineprivate

Definition at line 108 of file PartitionSwitchAlg.cpp.

                                                                                             {
        return m_actor ? (m_actor->*fun)(std::forward<Args>(args)...) : NO_INTERFACE;
   }

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

inlineoverride

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

Definition at line 143 of file PartitionSwitchAlg.cpp.

                                                                {
     auto sc = fwd_<CSTR,IInterface*&>(&IPartitionControl::get, nam, pPartition);
     return sc.isSuccess() ? sc : log_(sc, "Cannot get partition "+nam);
   }

STATUS PartitionSwitchAlg::initialize ( )

inlineoverride

Initialize.

Release old tool

Now check if the partition is present. If not: try to create it

Definition at line 52 of file PartitionSwitchAlg.cpp.

                                 {
     MsgStream log(msgSvc(), name());
     SmartIF<IAlgTool> tool(m_actor);
     STATUS sc = toolSvc()->retrieveTool(m_toolType,m_actor,this);
     if ( sc.isFailure() ) {
       log << MSG::ERROR << "Unable to load PartitionSwitchTool "
           << m_toolType << endmsg;
       return sc;
     }
     if ( tool ) toolSvc()->releaseTool(tool);
     IInterface* partititon = nullptr;
     sc = m_actor->get(m_partName, partititon);
     if ( !sc.isSuccess() )  {
       log << MSG::ERROR << "Cannot access partition \""
           << m_partName << "\"" << endmsg;
     }
     return sc;
   }

StatusCode PartitionSwitchAlg::log_	(	StatusCode	sc,
		const std::string &	msg
	)		const

inlineprivate

Definition at line 98 of file PartitionSwitchAlg.cpp.

                                                               {
     MsgStream log(msgSvc(), name());
     log << MSG::ERROR << msg << " Status=" << sc.getCode() << endmsg;
     return sc;
   }

Member Data Documentation

IPartitionControl* PartitionSwitchAlg::m_actor = nullptr

private

reference to Partition Controller

Definition at line 37 of file PartitionSwitchAlg.cpp.

std::string PartitionSwitchAlg::m_partName

private

Job option to set the requested partition name.

Definition at line 33 of file PartitionSwitchAlg.cpp.

std::string PartitionSwitchAlg::m_toolType

private

Job option to set the tool manipulating the multi-service name.

Definition at line 35 of file PartitionSwitchAlg.cpp.

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

GaudiCommonSvc/src/DataSvc/PartitionSwitchAlg.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation