PartitionSwitchAlg.cpp
Go to the documentation of this file.
1 // ====================================================================
2 // PartitionSwitchAlg.cpp
3 // --------------------------------------------------------------------
4 //
5 // Author : Markus Frank
6 //
7 // ====================================================================
10 #include "GaudiKernel/IToolSvc.h"
11 #include "GaudiKernel/IAlgTool.h"
12 #include "GaudiKernel/SmartIF.h"
13 
24 class PartitionSwitchAlg : public extends<Algorithm,
25  IPartitionControl> {
26 
27  using STATUS = StatusCode;
28  using CSTR = const std::string&;
29 
30 private:
31 
38 
39 public:
40 
43  : base_class(name, pSvcLocator)
44  {
45  declareProperty("Partition", m_partName);
46  declareProperty("Tool", m_toolType="PartitionSwitchTool");
47  }
49  ~PartitionSwitchAlg() override = default;
50 
52  STATUS initialize() override {
53  SmartIF<IAlgTool> tool(m_actor);
54  STATUS sc = toolSvc()->retrieveTool(m_toolType,m_actor,this);
55  if ( sc.isFailure() ) {
56  error() << "Unable to load PartitionSwitchTool "
57  << m_toolType << endmsg;
58  return sc;
59  }
61  if ( tool ) toolSvc()->releaseTool(tool);
63  IInterface* partititon = nullptr;
64  sc = m_actor->get(m_partName, partititon);
65  if ( !sc.isSuccess() ) {
66  error() << "Cannot access partition \""
67  << m_partName << "\"" << endmsg;
68  }
69  return sc;
70  }
71 
73  STATUS finalize() override {
74  SmartIF<IAlgTool> tool(m_actor);
75  if ( tool ) toolSvc()->releaseTool(tool);
76  m_actor = nullptr;
77  return STATUS::SUCCESS;
78  }
79 
81  STATUS execute() override {
82  if ( m_actor ) {
83  STATUS sc = m_actor->activate(m_partName);
84  if ( !sc.isSuccess() ) {
85  error() << "Cannot activate partition \""
86  << m_partName << "\"!" << endmsg;
87  }
88  return sc;
89  }
90  error() << "The partition control tool \"" << name()
91  << "." << m_toolType << "\" cannot be accessed!" << endmsg;
92  return STATUS::FAILURE;
93  }
94 private:
96  error() << msg << " Status=" << sc.getCode() << endmsg;
97  return sc;
98  }
99  template < typename...FArgs, typename...Args>
100  StatusCode fwd_( StatusCode (IPartitionControl::*fun)(FArgs...),Args&&... args) {
101  return m_actor ? (m_actor->*fun)(std::forward<Args>(args)...) : NO_INTERFACE;
102  }
103  template < typename...FArgs, typename...Args>
104  StatusCode fwd_( StatusCode (IPartitionControl::*fun)(FArgs...) const,Args&&... args) const {
105  return m_actor ? (m_actor->*fun)(std::forward<Args>(args)...) : NO_INTERFACE;
106  }
107 public:
109  STATUS create(CSTR nam, CSTR typ) override {
110  auto sc = fwd_<CSTR,CSTR>(&IPartitionControl::create,nam,typ);
111  return sc.isSuccess() ? sc : log_(sc, "Cannot create partition: "+nam+" of type "+typ);
112  }
114  STATUS create(CSTR nam, CSTR typ, IInterface*& pPartition) override {
115  auto sc = fwd_<CSTR,CSTR,IInterface*&>(&IPartitionControl::create,nam,typ,pPartition);
116  return sc.isSuccess() ? sc : log_(sc, "Cannot create partition: "+nam+" of type "+typ);
117  }
119  STATUS drop(CSTR nam) override {
120  auto sc = fwd_<CSTR>(&IPartitionControl::drop,nam);
121  return sc.isSuccess() ? sc : log_(sc, "Cannot drop partition: "+nam);
122  }
124  STATUS drop(IInterface* pPartition) override {
125  auto sc = fwd_<IInterface*>(&IPartitionControl::drop,pPartition);
126  return sc.isSuccess() ? sc : log_(sc, "Cannot drop partition by Interface.");
127  }
129  STATUS activate(CSTR nam) override {
130  auto sc = fwd_<CSTR>(&IPartitionControl::activate,nam);
131  return sc.isSuccess() ? sc : log_(sc, "Cannot activate partition: "+nam);
132  }
134  STATUS activate(IInterface* pPartition) override {
135  auto sc = fwd_<IInterface*>(&IPartitionControl::activate, pPartition);
136  return sc.isSuccess() ? sc : log_(sc, "Cannot activate partition by Interface.");
137  }
139  STATUS get(CSTR nam, IInterface*& pPartition) const override {
140  auto sc = fwd_<CSTR,IInterface*&>(&IPartitionControl::get, nam, pPartition);
141  return sc.isSuccess() ? sc : log_(sc, "Cannot get partition "+nam);
142  }
144  STATUS activePartition(std::string& nam, IInterface*& pPartition) const override {
145  auto sc = fwd_<std::string&,IInterface*&>(&IPartitionControl::activePartition,nam,pPartition);
146  return sc.isSuccess() ? sc : log_(sc, "Cannot determine active partition.");
147  }
148 };
149 
StatusCode fwd_(StatusCode(IPartitionControl::*fun)(FArgs...) const, Args &&...args) const
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:14
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
STATUS initialize() override
Initialize.
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
virtual StatusCode activePartition(std::string &name, IInterface *&pPartition) const =0
Access the active partition object.
unsigned long getCode() const
Get the status code by value.
Definition: StatusCode.h:93
STATUS drop(IInterface *pPartition) override
Drop a partition object. The name identifies the partition uniquely.
StatusCode log_(StatusCode sc, const std::string &msg) const
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:76
virtual StatusCode create(const std::string &name, const std::string &type)=0
Create a partition object. The name identifies the partition uniquely.
STATUS finalize() override
Finalize.
Property * declareProperty(const std::string &name, T &property, const std::string &doc="none") const
Declare the named property.
Definition: Algorithm.h:426
StatusCode fwd_(StatusCode(IPartitionControl::*fun)(FArgs...), Args &&...args)
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:145
#define DECLARE_COMPONENT(type)
Definition: PluginService.h:36
STL class.
SmartIF< IToolSvc > & toolSvc() const
The standard ToolSvc service, Return a pointer to the service if present.
const std::string & name() const override
The identifying name of the algorithm object.
Definition: Algorithm.cpp:820
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
~PartitionSwitchAlg() override=default
Standard Destructor.
STATUS drop(CSTR nam) override
Drop a partition object. The name identifies the partition uniquely.
std::string m_partName
Job option to set the requested partition name.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
Definition of the basic interface.
Definition: IInterface.h:234
virtual StatusCode get(const std::string &name, IInterface *&pPartition) const =0
Access a partition object. The name identifies the partition uniquely.
PartitionSwitchAlg(const std::string &name, ISvcLocator *pSvcLocator)
Standard algorithm constructor.
STATUS create(CSTR nam, CSTR typ, IInterface *&pPartition) override
Create a partition object. The name identifies the partition uniquely.
Small algorithm which switches the partition of a configurable multi-service.
STATUS activate(IInterface *pPartition) override
Activate a partition object.
list args
Definition: gaudirun.py:290
Create / access partitions.
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
double fun(const std::vector< double > &x)
Definition: PFuncTest.cpp:26
STATUS create(CSTR nam, CSTR typ) override
Create a partition object. The name identifies the partition uniquely.
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.
virtual StatusCode activate(const std::string &name)=0
Activate a partition object. The name identifies the partition uniquely.
virtual StatusCode releaseTool(IAlgTool *tool)=0
Release the tool.
STATUS activate(CSTR nam) override
Activate a partition object. The name identifies the partition uniquely.
STATUS activePartition(std::string &nam, IInterface *&pPartition) const override
Access the active partition object.
std::string m_toolType
Job option to set the tool manipulating the multi-service name.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
STATUS execute() override
Execute procedure.