The Gaudi Framework  v30r3 (a5ef0a68)
PartitionSwitchTool Class Reference
Inheritance diagram for PartitionSwitchTool:
Collaboration diagram for PartitionSwitchTool:

Public Member Functions

STATUS initialize () override
 Initialize. More...
 
STATUS finalize () override
 Finalize. More...
 
void _check (STATUS sc, CSTR msg) const
 
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< AlgTool, 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...
 
- Public Member Functions inherited from AlgTool
StatusCode queryInterface (const InterfaceID &riid, void **ppvUnknown) override
 Query for a given interface. More...
 
const std::stringname () const override
 Retrieve full identifying name of the concrete tool object. More...
 
const std::stringtype () const override
 Retrieve type (concrete class) of the sub-algtool. More...
 
const IInterfaceparent () const override
 Retrieve parent of the sub-algtool. More...
 
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. More...
 
StatusCode sysStart () override
 Start AlgTool. More...
 
StatusCode sysStop () override
 Stop AlgTool. More...
 
StatusCode sysFinalize () override
 Finalize AlgTool. More...
 
StatusCode sysReinitialize () override
 Initialize AlgTool. More...
 
StatusCode sysRestart () override
 Start AlgTool. More...
 
 AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
ISvcLocatorsvcLoc () const
 shortcut for the method service locator More...
 
IDataProviderSvcevtSvc () const
 accessor to event service service More...
 
IToolSvctoolSvc () const
 The standard ToolSvc service, Return a pointer to the service if present. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified in the jobOptions via the job option service. More...
 
template<class T >
StatusCode service (const std::string &name, T *&svc, 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 &type, const std::string &name, T *&svc) const
 Access a service by name, 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<typename T >
SmartIF< T > service (const std::string &name, const bool createIf=true, const bool quiet=false) const
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (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, std::string toolTypeAndName, bool createIf=true)
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (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
 
IAuditorSvcauditorSvc () const
 Access the auditor service. More...
 
IMonitorSvcmonitorSvc () 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...
 
 ~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 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< IAlgTool, 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...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
 PropertyHolder ()=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, 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
 
- 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) More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const
 Backward compatibility function for getting the output level. More...
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
const 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...
 

Private Types

using CSTR = const std::string &
 
using STATUS = StatusCode
 

Private Attributes

Gaudi::Property< std::stringm_actorName {this, "Actor", "EventDataService", "option to set the multi-service name"}
 
SmartIF< IPartitionControlm_actor
 reference to Partition Controller More...
 

Additional Inherited Members

- Public Types inherited from extends< AlgTool, 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 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 = 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< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IAlgTool, 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 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 More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from AlgTool
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< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl m_inputDataObjs
 
DataObjIDColl m_outputDataObjs
 

Detailed Description

Author
Markus Frank
Date
2004-06-24

Definition at line 12 of file PartitionSwitchTool.cpp.

Member Typedef Documentation

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

Definition at line 15 of file PartitionSwitchTool.cpp.

Definition at line 16 of file PartitionSwitchTool.cpp.

Member Function Documentation

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

Definition at line 52 of file PartitionSwitchTool.cpp.

52 { error() << msg << " Status=" << sc.getCode() << endmsg; }
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
STATUS PartitionSwitchTool::activate ( CSTR  nam)
inlineoverride

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

Definition at line 82 of file PartitionSwitchTool.cpp.

83  {
85  CHECK( sc, "Cannot activate partition: " + nam );
86  }
Requested interface is not available.
SmartIF< 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.
#define CHECK(x, y)
STATUS PartitionSwitchTool::activate ( IInterface pPartition)
inlineoverride

Activate a partition object.

Definition at line 88 of file PartitionSwitchTool.cpp.

89  {
91  CHECK( sc, "Cannot activate partition by Interface." );
92  }
Requested interface is not available.
SmartIF< 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.
#define CHECK(x, y)
STATUS PartitionSwitchTool::activePartition ( std::string nam,
IInterface *&  pPartition 
) const
inlineoverride

Access the active partition object.

Definition at line 100 of file PartitionSwitchTool.cpp.

101  {
103  CHECK( sc, "Cannot determine active partition." );
104  }
Requested interface is not available.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
virtual StatusCode activePartition(std::string &name, IInterface *&pPartition) const =0
Access the active partition object.
#define CHECK(x, y)
STATUS PartitionSwitchTool::create ( CSTR  nam,
CSTR  typ 
)
inlineoverride

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

Definition at line 58 of file PartitionSwitchTool.cpp.

59  {
61  CHECK( sc, "Cannot create partition: " + nam + " of type " + typ );
62  }
Requested interface is not available.
virtual StatusCode create(const std::string &name, const std::string &type)=0
Create a partition object. The name identifies the partition uniquely.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
#define CHECK(x, y)
STATUS PartitionSwitchTool::create ( CSTR  nam,
CSTR  typ,
IInterface *&  pPartition 
)
inlineoverride

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

Definition at line 64 of file PartitionSwitchTool.cpp.

65  {
66  STATUS sc = m_actor ? m_actor->create( nam, typ, pPartition ) : IInterface::Status::NO_INTERFACE;
67  CHECK( sc, "Cannot create partition: " + nam + " of type " + typ );
68  }
Requested interface is not available.
virtual StatusCode create(const std::string &name, const std::string &type)=0
Create a partition object. The name identifies the partition uniquely.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
#define CHECK(x, y)
STATUS PartitionSwitchTool::drop ( CSTR  nam)
inlineoverride

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

Definition at line 70 of file PartitionSwitchTool.cpp.

71  {
73  CHECK( sc, "Cannot drop partition: " + nam );
74  }
Requested interface is not available.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
virtual StatusCode drop(const std::string &name)=0
Drop a partition object. The name identifies the partition uniquely.
#define CHECK(x, y)
STATUS PartitionSwitchTool::drop ( IInterface pPartition)
inlineoverride

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

Definition at line 76 of file PartitionSwitchTool.cpp.

77  {
79  CHECK( sc, "Cannot drop partition by Interface." );
80  }
Requested interface is not available.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
virtual StatusCode drop(const std::string &name)=0
Drop a partition object. The name identifies the partition uniquely.
#define CHECK(x, y)
STATUS PartitionSwitchTool::finalize ( )
inlineoverride

Finalize.

Definition at line 46 of file PartitionSwitchTool.cpp.

47  {
48  m_actor = nullptr;
49  return AlgTool::finalize();
50  }
StatusCode finalize() override
Definition: AlgTool.cpp:293
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
STATUS PartitionSwitchTool::get ( CSTR  nam,
IInterface *&  pPartition 
) const
inlineoverride

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

Definition at line 94 of file PartitionSwitchTool.cpp.

95  {
96  STATUS sc = m_actor ? m_actor->get( nam, pPartition ) : IInterface::Status::NO_INTERFACE;
97  CHECK( sc, "Cannot get partition " + nam );
98  }
Requested interface is not available.
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
virtual StatusCode get(const std::string &name, IInterface *&pPartition) const =0
Access a partition object. The name identifies the partition uniquely.
#define CHECK(x, y)
STATUS PartitionSwitchTool::initialize ( )
inlineoverride

Initialize.

Access partitioned multi-service

Definition at line 27 of file PartitionSwitchTool.cpp.

28  {
31  if ( !sc.isSuccess() ) {
32  error() << "Cannot initialize base class!" << endmsg;
33  return sc;
34  }
35  m_actor = nullptr;
36  IPartitionControl* tmpPtr = nullptr;
37  sc = service( m_actorName, tmpPtr );
38  m_actor = tmpPtr;
39  if ( !sc.isSuccess() ) {
40  error() << "Cannot retrieve partition controller \"" << m_actorName.value() << "\"!" << endmsg;
41  return sc;
42  }
43  return sc;
44  }
StatusCode initialize() override
Definition: AlgTool.cpp:223
Gaudi::Property< std::string > m_actorName
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
SmartIF< IPartitionControl > m_actor
reference to Partition Controller
StatusCode service(const std::string &name, T *&svc, bool createIf=true) const
Access a service by name, creating it if it doesn&#39;t already exist.
Definition: AlgTool.h:129
Create / access partitions.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209

Member Data Documentation

SmartIF<IPartitionControl> PartitionSwitchTool::m_actor
private

reference to Partition Controller

Definition at line 21 of file PartitionSwitchTool.cpp.

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

Definition at line 19 of file PartitionSwitchTool.cpp.


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