The Gaudi Framework  v29r0 (ff2e7097)
PartitionSwitchAlg Class Reference

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

Inheritance diagram for PartitionSwitchAlg:
Collaboration diagram for PartitionSwitchAlg:

Public Member Functions

 ~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< Algorithm, IPartitionControl >
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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
 Constructor. More...
 
StatusCode sysStart () override
 Reinitialization method invoked by the framework. More...
 
StatusCode sysInitialize () override
 Initialization method invoked by the framework. More...
 
StatusCode sysReinitialize () override
 Reinitialization method invoked by the framework. More...
 
StatusCode sysRestart () override
 Restart method invoked by the framework. More...
 
StatusCode sysExecute (const EventContext &ctx) override
 The actions to be performed by the algorithm on an event. More...
 
StatusCode sysStop () override
 System stop. More...
 
StatusCode sysFinalize () override
 System finalization. More...
 
StatusCode sysBeginRun () override
 beginRun method invoked by the framework. More...
 
StatusCode sysEndRun () override
 endRun method invoked by the framework. More...
 
const std::stringname () const override
 The identifying name of the algorithm object. More...
 
const Gaudi::StringKeynameKey () const override
 
const std::stringtype () const override
 The type of the algorithm object. More...
 
void setType (const std::string &type) override
 
const std::stringversion () const override
 
unsigned int index () const override
 
StatusCode configure () override
 Dummy implementation of IStateful::configure() method. More...
 
StatusCode terminate () override
 Dummy implementation of IStateful::terminate() method. More...
 
StatusCode initialize () override
 the default (empty) implementation of IStateful::initialize() method More...
 
StatusCode start () override
 the default (empty) implementation of IStateful::start() method More...
 
StatusCode stop () override
 the default (empty) implementation of IStateful::stop() method More...
 
StatusCode finalize () override
 the default (empty) implementation of IStateful::finalize() method More...
 
StatusCode reinitialize () override
 the default (empty) implementation of IStateful::reinitialize() method More...
 
StatusCode restart () override
 the default (empty) implementation of IStateful::restart() method More...
 
Gaudi::StateMachine::State FSMState () const override
 returns the current state of the algorithm More...
 
Gaudi::StateMachine::State targetFSMState () const override
 returns the state the algorithm will be in after the ongoing transition More...
 
bool isExecuted () const override
 Has this algorithm been executed since the last reset? More...
 
void setExecuted (bool state) const override
 Set the executed flag to the specified state. More...
 
void resetExecuted () override
 Reset the executed state of the Algorithm for the duration of the current event. More...
 
StatusCode beginRun () override
 Algorithm begin run. More...
 
StatusCode endRun () override
 Algorithm end run. This method is called at the end of the event loop. More...
 
bool isEnabled () const override
 Is this algorithm enabled or disabled? More...
 
bool isSequence () const override
 Are we a Sequence? More...
 
bool filterPassed () const override
 Did this algorithm pass or fail its filter criterion for the last event? More...
 
void setFilterPassed (bool state) const override
 Set the filter passed flag to the specified state. More...
 
unsigned int errorCount () const
 Get the number of failures of the algorithm. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, 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 &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
SmartIF< IServiceservice (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...
 
template<class T >
SmartIF< T > service (const std::string &name, bool createIf=true, bool quiet=false) const
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
SmartIF< IChronoStatSvc > & chronoSvc () const
 The standard Chrono & Stat service, Return a pointer to the service if present. More...
 
SmartIF< IChronoStatSvc > & chronoStatService () const
 
SmartIF< IDataProviderSvc > & detSvc () const
 The standard detector data service. More...
 
SmartIF< IDataProviderSvc > & detDataService () const
 
SmartIF< IConversionSvc > & detCnvSvc () const
 The standard detector data persistency conversion service. More...
 
SmartIF< IConversionSvc > & detDataCnvService () const
 
SmartIF< IDataProviderSvc > & eventSvc () const
 The standard event data service. More...
 
SmartIF< IDataProviderSvc > & evtSvc () const
 shortcut for method eventSvc More...
 
SmartIF< IDataProviderSvc > & eventDataService () const
 
SmartIF< IConversionSvc > & eventCnvSvc () const
 The standard event data persistency conversion service. More...
 
SmartIF< IConversionSvc > & eventDataCnvService () const
 
SmartIF< IHistogramSvc > & histoSvc () const
 The standard histogram service. More...
 
SmartIF< IHistogramSvc > & histogramDataService () const
 
SmartIF< INTupleSvc > & ntupleSvc () const
 The standard N tuple service. More...
 
SmartIF< INTupleSvc > & ntupleService () const
 
SmartIF< IRndmGenSvc > & randSvc () const
 The standard RandomGen service, Return a pointer to the service if present. More...
 
SmartIF< IToolSvc > & toolSvc () const
 The standard ToolSvc service, Return a pointer to the service if present. More...
 
SmartIF< IExceptionSvc > & exceptionSvc () const
 Get the exception Service. More...
 
SmartIF< IAlgContextSvc > & contextSvc () const
 get Algorithm Context Service More...
 
SmartIF< ITimelineSvc > & timelineSvc () const
 
SmartIF< ISvcLocator > & serviceLocator () const override
 The standard service locator. More...
 
SmartIF< ISvcLocator > & svcLoc () const
 shortcut for method serviceLocator More...
 
SmartIF< IHiveWhiteBoard > & whiteboard () const
 
SmartIF< IAlgExecStateSvc > & algExecStateSvc () const
 
bool registerContext () const
 register for Algorithm Context Service? More...
 
StatusCode createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
 Create a sub algorithm. More...
 
const std::vector< Algorithm * > * subAlgorithms () const
 List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
 
std::vector< Algorithm * > * subAlgorithms ()
 List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
 
StatusCode setProperties ()
 Set the algorithm's properties. More...
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
 
SmartIF< 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...
 
const EventContextgetContext () const override
 get the context More...
 
virtual void acceptDHVisitor (IDataHandleVisitor *) const override
 
void commitHandles () override
 
void registerTool (IAlgTool *tool) const
 
void deregisterTool (IAlgTool *tool) const
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
 
template<class T >
void addToolsArray (ToolHandleArray< T > &hndlArr)
 
const std::vector< IAlgTool * > & tools () const
 
bool isIOBound () const
 
void setIOBound (bool value)
 
unsigned int cardinality () const override
 Return the cardinality. More...
 
const std::vector< std::string > & neededResources () const override
 
std::ostreamtoControlFlowExpression (std::ostream &os) const override
 Produce string represention of the control flow expression. More...
 
- Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * > inputHandles () const override
 
std::vector< Gaudi::DataHandle * > outputHandles () const override
 
virtual const DataObjIDCollextraInputDeps () const override
 
virtual const DataObjIDCollextraOutputDeps () const override
 
void declare (Gaudi::DataHandle &handle) override
 
void renounce (Gaudi::DataHandle &handle) override
 
const DataObjIDCollinputDataObjs () const override
 
const DataObjIDColloutputDataObjs () const override
 
void addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
 
- Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
 PropertyHolder ()=default
 
 ~PropertyHolder () override=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p) override
 set the property form another property More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 set the property from name and the value More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (const std::string &name) const override
 get the property by name More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (const std::string &name) const override
 Return true if we have a property with the given name. More...
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
 Specializations for various GaudiHandles. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const __attribute__((deprecated))
 Backward compatibility function for getting the output level. More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
- Public Member Functions inherited from extend_interfaces< Interfaces... >
 ~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

Gaudi::Property< std::stringm_partName {this, "Partition", "", "option to set the requested partition name"}
 
Gaudi::Property< std::stringm_toolType
 
IPartitionControlm_actor = nullptr
 reference to Partition Controller More...
 

Additional Inherited Members

- Public Types inherited from extends< Algorithm, IPartitionControl >
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 Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm *, const std::string &, ISvcLocator * > Factory
 
- Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
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 PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using base_class = CommonMessaging
 
- 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...
 
- Protected Member Functions inherited from Algorithm
std::vector< IAlgTool * > & tools ()
 
bool isInitialized () const override
 Has the Algorithm already been initialized? More...
 
bool isFinalized () const override
 Has the Algorithm already been finalized? More...
 
void setIndex (const unsigned int &idx) override
 set instantiation index of Alg More...
 
- Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void initDataHandleHolder ()
 initializes all handles - called by the sysInitialize method of any descendant of this More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from Algorithm
std::unique_ptr< IDataHandleVisitorm_updateDataHandles
 Hook for for derived classes to provide a custom visitor for data handles. More...
 
- Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl m_inputDataObjs
 
DataObjIDColl m_outputDataObjs
 

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 24 of file PartitionSwitchAlg.cpp.

Member Typedef Documentation

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

Definition at line 28 of file PartitionSwitchAlg.cpp.

Definition at line 27 of file PartitionSwitchAlg.cpp.

Constructor & Destructor Documentation

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 130 of file PartitionSwitchAlg.cpp.

131  {
132  auto sc = fwd_<CSTR>( &IPartitionControl::activate, nam );
133  return sc.isSuccess() ? sc : log_( sc, "Cannot activate partition: " + nam );
134  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode activate(const std::string &name)=0
Activate a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::activate ( IInterface pPartition)
inlineoverride

Activate a partition object.

Definition at line 136 of file PartitionSwitchAlg.cpp.

137  {
138  auto sc = fwd_<IInterface*>( &IPartitionControl::activate, pPartition );
139  return sc.isSuccess() ? sc : log_( sc, "Cannot activate partition by Interface." );
140  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode activate(const std::string &name)=0
Activate a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::activePartition ( std::string nam,
IInterface *&  pPartition 
) const
inlineoverride

Access the active partition object.

Definition at line 148 of file PartitionSwitchAlg.cpp.

149  {
150  auto sc = fwd_<std::string&, IInterface*&>( &IPartitionControl::activePartition, nam, pPartition );
151  return sc.isSuccess() ? sc : log_( sc, "Cannot determine active partition." );
152  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode activePartition(std::string &name, IInterface *&pPartition) const =0
Access the active partition object.
STATUS PartitionSwitchAlg::create ( CSTR  nam,
CSTR  typ 
)
inlineoverride

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

Definition at line 106 of file PartitionSwitchAlg.cpp.

107  {
108  auto sc = fwd_<CSTR, CSTR>( &IPartitionControl::create, nam, typ );
109  return sc.isSuccess() ? sc : log_( sc, "Cannot create partition: " + nam + " of type " + typ );
110  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode create(const std::string &name, const std::string &type)=0
Create a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::create ( CSTR  nam,
CSTR  typ,
IInterface *&  pPartition 
)
inlineoverride

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

Definition at line 112 of file PartitionSwitchAlg.cpp.

113  {
114  auto sc = fwd_<CSTR, CSTR, IInterface*&>( &IPartitionControl::create, nam, typ, pPartition );
115  return sc.isSuccess() ? sc : log_( sc, "Cannot create partition: " + nam + " of type " + typ );
116  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode create(const std::string &name, const std::string &type)=0
Create a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::drop ( CSTR  nam)
inlineoverride

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

Definition at line 118 of file PartitionSwitchAlg.cpp.

119  {
120  auto sc = fwd_<CSTR>( &IPartitionControl::drop, nam );
121  return sc.isSuccess() ? sc : log_( sc, "Cannot drop partition: " + nam );
122  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode drop(const std::string &name)=0
Drop a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::drop ( IInterface pPartition)
inlineoverride

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

Definition at line 124 of file PartitionSwitchAlg.cpp.

125  {
126  auto sc = fwd_<IInterface*>( &IPartitionControl::drop, pPartition );
127  return sc.isSuccess() ? sc : log_( sc, "Cannot drop partition by Interface." );
128  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode drop(const std::string &name)=0
Drop a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::execute ( )
inlineoverride

Execute procedure.

Definition at line 74 of file PartitionSwitchAlg.cpp.

75  {
76  if ( m_actor ) {
78  if ( !sc.isSuccess() ) {
79  error() << "Cannot activate partition \"" << m_partName << "\"!" << endmsg;
80  }
81  return sc;
82  }
83  error() << "The partition control tool \"" << name() << "." << m_toolType << "\" cannot be accessed!" << endmsg;
84  return STATUS::FAILURE;
85  }
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:731
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
Gaudi::Property< std::string > m_toolType
Gaudi::Property< std::string > m_partName
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
IPartitionControl * m_actor
reference to Partition Controller
virtual StatusCode activate(const std::string &name)=0
Activate a partition object. The name identifies the partition uniquely.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
STATUS PartitionSwitchAlg::finalize ( )
inlineoverride

Finalize.

Definition at line 65 of file PartitionSwitchAlg.cpp.

66  {
67  SmartIF<IAlgTool> tool( m_actor );
68  if ( tool ) toolSvc()->releaseTool( tool );
69  m_actor = nullptr;
70  return STATUS::SUCCESS;
71  }
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:15
SmartIF< IToolSvc > & toolSvc() const
The standard ToolSvc service, Return a pointer to the service if present.
Definition: Algorithm.cpp:803
IPartitionControl * m_actor
reference to Partition Controller
virtual StatusCode releaseTool(IAlgTool *tool)=0
Release the tool.
template<typename... FArgs, typename... Args>
StatusCode PartitionSwitchAlg::fwd_ ( StatusCode(IPartitionControl::*)(FArgs...)  fun,
Args &&...  args 
)
inlineprivate

Definition at line 94 of file PartitionSwitchAlg.cpp.

95  {
96  return m_actor ? ( m_actor->*fun )( std::forward<Args>( args )... ) : NO_INTERFACE;
97  }
double fun(const std::vector< double > &x)
Definition: PFuncTest.cpp:26
IPartitionControl * m_actor
reference to Partition Controller
template<typename... FArgs, typename... Args>
StatusCode PartitionSwitchAlg::fwd_ ( StatusCode(IPartitionControl::*)(FArgs...) const  fun,
Args &&...  args 
) const
inlineprivate

Definition at line 99 of file PartitionSwitchAlg.cpp.

100  {
101  return m_actor ? ( m_actor->*fun )( std::forward<Args>( args )... ) : NO_INTERFACE;
102  }
double fun(const std::vector< double > &x)
Definition: PFuncTest.cpp:26
IPartitionControl * m_actor
reference to Partition Controller
STATUS PartitionSwitchAlg::get ( CSTR  nam,
IInterface *&  pPartition 
) const
inlineoverride

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

Definition at line 142 of file PartitionSwitchAlg.cpp.

143  {
144  auto sc = fwd_<CSTR, IInterface*&>( &IPartitionControl::get, nam, pPartition );
145  return sc.isSuccess() ? sc : log_( sc, "Cannot get partition " + nam );
146  }
StatusCode log_(StatusCode sc, const std::string &msg) const
virtual StatusCode get(const std::string &name, IInterface *&pPartition) const =0
Access a partition object. The name identifies the partition uniquely.
STATUS PartitionSwitchAlg::initialize ( )
inlineoverride

Initialize.

Release old tool

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

Definition at line 45 of file PartitionSwitchAlg.cpp.

46  {
47  SmartIF<IAlgTool> tool( m_actor );
48  STATUS sc = toolSvc()->retrieveTool( m_toolType, m_actor, this );
49  if ( sc.isFailure() ) {
50  error() << "Unable to load PartitionSwitchTool " << m_toolType << endmsg;
51  return sc;
52  }
54  if ( tool ) toolSvc()->releaseTool( tool );
56  IInterface* partititon = nullptr;
57  sc = m_actor->get( m_partName, partititon );
58  if ( !sc.isSuccess() ) {
59  error() << "Cannot access partition \"" << m_partName << "\"" << endmsg;
60  }
61  return sc;
62  }
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:15
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:75
SmartIF< IToolSvc > & toolSvc() const
The standard ToolSvc service, Return a pointer to the service if present.
Definition: Algorithm.cpp:803
Gaudi::Property< std::string > m_toolType
Gaudi::Property< std::string > m_partName
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
StatusCode retrieveTool(const std::string &type, T *&tool, const IInterface *parent=nullptr, bool createIf=true)
Retrieve specified tool sub-type with tool dependent part of the name automatically assigned...
Definition: IToolSvc.h:139
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
virtual StatusCode get(const std::string &name, IInterface *&pPartition) const =0
Access a partition object. The name identifies the partition uniquely.
Definition of the basic interface.
Definition: IInterface.h:277
IPartitionControl * m_actor
reference to Partition Controller
virtual StatusCode releaseTool(IAlgTool *tool)=0
Release the tool.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
StatusCode PartitionSwitchAlg::log_ ( StatusCode  sc,
const std::string msg 
) const
inlineprivate

Definition at line 88 of file PartitionSwitchAlg.cpp.

89  {
90  error() << msg << " Status=" << sc.getCode() << endmsg;
91  return sc;
92  }
unsigned long getCode() const
Get the status code by value.
Definition: StatusCode.h:94
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

Member Data Documentation

IPartitionControl* PartitionSwitchAlg::m_actor = nullptr
private

reference to Partition Controller

Definition at line 36 of file PartitionSwitchAlg.cpp.

Gaudi::Property<std::string> PartitionSwitchAlg::m_partName {this, "Partition", "", "option to set the requested partition name"}
private

Definition at line 31 of file PartitionSwitchAlg.cpp.

Gaudi::Property<std::string> PartitionSwitchAlg::m_toolType
private
Initial value:
{this, "Tool", "PartitionSwitchTool",
"option to set the tool manipulating the multi-service name"}

Definition at line 32 of file PartitionSwitchAlg.cpp.


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