| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

GaudiTool.cpp
Go to the documentation of this file.
1 // ============================================================================
2 // Include files
3 // ============================================================================
4 // GaudiKernel
5 // ============================================================================
6 #include "GaudiKernel/Bootstrap.h"
7 #include "GaudiKernel/IAlgContextSvc.h"
8 #include "GaudiKernel/IChronoStatSvc.h"
9 #include "GaudiKernel/IDataProviderSvc.h"
10 #include "GaudiKernel/IHistogramSvc.h"
11 #include "GaudiKernel/IIncidentSvc.h"
12 #include "GaudiKernel/INTupleSvc.h"
13 // ============================================================================
14 // GaudiAlg
15 // ============================================================================
16 #include "GaudiAlg/GaudiAlgorithm.h"
17 #include "GaudiAlg/GaudiTool.h"
18 // ============================================================================
26 // ============================================================================
27 // templated methods
28 // ============================================================================
29 #include "GaudiCommon.icpp"
30 // ============================================================================
31 template class GaudiCommon<AlgTool>;
32 // ============================================================================
39 // ============================================================================
40 namespace GaudiToolServices
41 {
43 const std::string s_EventDataSvc = "EventDataSvc";
45 const std::string s_DetectorDataSvc = "DetectorDataSvc";
47 const std::string s_ChronoStatSvc = "ChronoStatSvc";
49 const std::string s_IncidentSvc = "IncidentSvc";
51 const std::string s_HistoSvc = "HistogramDataSvc";
52 }
53 // ============================================================================
54 namespace GaudiToolLocal
55 {
56 // ==========================================================================
60 class Counter final
61 {
62 public:
63 // ========================================================================
64 // constructor
65 Counter( std::string msg = " Misbalance " ) : m_message( std::move( msg ) ){};
66 // destructor
67 ~Counter() { report(); }
68 // ========================================================================
69 public:
70 // ========================================================================
72 long increment( const std::string& object ) { return ++m_map[object]; }
74 long decrement( const std::string& object ) { return --m_map[object]; }
76 long counts( const std::string& object ) { return m_map[object]; }
78 void report() const
79 {
81 if ( !GaudiTool::summaryEnabled() ) {
82 return;
83 } // RETURN
84 //
85 for ( const auto& entry : m_map ) {
86 if ( entry.second ) {
87 std::cout << "GaudiTool WARNING " << m_message << "'" << entry.first << "' Counts = " << entry.second
88 << std::endl;
89 }
90 }
91 }
92 // ========================================================================
93 private:
94 // ========================================================================
95 typedef std::map<std::string, long> Map;
96 Map m_map;
97 std::string m_message;
98 // ========================================================================
99 };
100 // ==========================================================================
106 static Counter s_InstanceCounter( " Create/Destroy (mis)balance " );
107 // ==========================================================================
113 static Counter s_FinalizeCounter( " Initialize/Finalize (mis)balance " );
114 // ==========================================================================
115 }
116 // ============================================================================
118 // ============================================================================
119 bool GaudiTool::s_enableSummary = true; // summary is enabled
120 // ============================================================================
121 // enable/disable summary
122 // ============================================================================
123 bool GaudiTool::enableSummary( bool value ) // enable/disable summary
124 {
125 s_enableSummary = value;
126 return summaryEnabled();
127 }
128 // ============================================================================
129 // is summary enabled?
130 // ============================================================================
131 bool GaudiTool::summaryEnabled() // is summary enabled?
132 {
133 return s_enableSummary;
134 }
135 // ============================================================================
136 // Standard constructor
137 // ============================================================================
138 GaudiTool::GaudiTool( const std::string& this_type, const std::string& this_name, const IInterface* parent )
139 : GaudiCommon<AlgTool>( this_type, this_name, parent ), m_local( this_type + "/" + this_name )
140 {
141 // make instance counts
142 GaudiToolLocal::s_InstanceCounter.increment( m_local );
143 }
144 // ============================================================================
145 // destructor
146 // ============================================================================
147 GaudiTool::~GaudiTool() { GaudiToolLocal::s_InstanceCounter.decrement( m_local ); }
148 // ============================================================================
149 // standard initialization method
150 // ============================================================================
151 StatusCode GaudiTool::initialize()
152 {
153 // initialize the base class
154 const StatusCode sc = GaudiCommon<AlgTool>::initialize();
155 if ( sc.isFailure() ) {
156 return sc;
157 }
158
159 // increment the counter
160 GaudiToolLocal::s_FinalizeCounter.increment( m_local );
161
162 // are we a public tool ?
163 m_isPublic = isPublic();
164
165 // return
166 return sc;
167 }
168 // ============================================================================
169 // standard finalization method
170 // ============================================================================
171 StatusCode GaudiTool::finalize()
172 {
173 if ( msgLevel( MSG::DEBUG ) ) debug() << " ==> Finalize the base class GaudiTool " << endmsg;
174
175 // clear "explicit services"
176 m_detSvc.reset();
177 m_chronoSvc.reset();
178 m_incSvc.reset();
179 m_histoSvc.reset();
180
181 // finalize the base class
182 const StatusCode sc = GaudiCommon<AlgTool>::finalize();
183 if ( sc.isFailure() ) {
184 return sc;
185 }
186
187 // Decrement the counter
188 GaudiToolLocal::s_FinalizeCounter.decrement( m_local );
189
190 // return
191 return sc;
192 }
193 // ============================================================================
194 // Determines if this tool is public or not (i.e. owned by the ToolSvc).
195 // ============================================================================
196 bool GaudiTool::isPublic() const
197 {
198 const IAlgTool* tool = this;
199 // Recurse down the ownership tree, to see with we ever end up at the ToolSvc
200 bool ownedByToolSvc = false;
201 unsigned int sanityCheck( 0 );
202 while ( tool && ++sanityCheck < 99999 ) {
203 ownedByToolSvc = ( nullptr != dynamic_cast<const IToolSvc*>( tool->parent() ) );
204 if ( ownedByToolSvc ) {
205 break;
206 }
207 // if parent is also a tool, try again
208 tool = dynamic_cast<const IAlgTool*>( tool->parent() );
209 }
210 return ownedByToolSvc;
211 }
212 // ============================================================================
213 // accessor to detector service
214 // ============================================================================
215 IDataProviderSvc* GaudiTool::detSvc() const
216 {
217 if ( UNLIKELY( !m_detSvc ) ) m_detSvc = service( GaudiToolServices::s_DetectorDataSvc, true );
218 return m_detSvc;
219 }
220 // ============================================================================
221 // The standard N-Tuple
222 // ============================================================================
223 INTupleSvc* GaudiTool::ntupleSvc() const
224 {
225 if ( UNLIKELY( !m_ntupleSvc ) ) m_ntupleSvc = service( "NTupleSvc", true );
226 return m_ntupleSvc;
227 }
228 // ============================================================================
229 // The standard event collection service
230 // ============================================================================
231 INTupleSvc* GaudiTool::evtColSvc() const
232 {
233 if ( UNLIKELY( !m_evtColSvc ) ) m_evtColSvc = service( "EvtTupleSvc", true );
234 return m_evtColSvc;
235 }
236 // ============================================================================
237 // accessor to Incident Service
238 // ============================================================================
239 IIncidentSvc* GaudiTool::incSvc() const
240 {
241 if ( UNLIKELY( !m_incSvc ) ) m_incSvc = service( GaudiToolServices::s_IncidentSvc, true );
242 return m_incSvc;
243 }
244 // ============================================================================
245 // accessor to Chrono & Stat Service
246 // ============================================================================
247 IChronoStatSvc* GaudiTool::chronoSvc() const
248 {
249 if ( UNLIKELY( !m_chronoSvc ) ) m_chronoSvc = service( GaudiToolServices::s_ChronoStatSvc, true );
250 return m_chronoSvc;
251 }
252 // ============================================================================
253 // accessor to histogram Service
254 // ============================================================================
255 IHistogramSvc* GaudiTool::histoSvc() const
256 {
257 if ( UNLIKELY( !m_histoSvc ) ) m_histoSvc = service( GaudiToolServices::s_HistoSvc, true );
258 return m_histoSvc;
259 }
260 // ============================================================================
261 // accessor to Algorithm Context Service
262 // ============================================================================
263 IAlgContextSvc* GaudiTool::contextSvc() const
264 {
265 if ( UNLIKELY( !m_contextSvc ) ) m_contextSvc = service( m_contextSvcName, true );
266 return m_contextSvc;
267 }
268 // ============================================================================
269 // The END
270 // ============================================================================
GaudiTool::chronoSvc
IChronoStatSvc * chronoSvc() const
accessor to Chrono & Stat Service
Definition: GaudiTool.cpp:247
GaudiTool::incSvc
IIncidentSvc * incSvc() const
accessor to Incident Service
Definition: GaudiTool.cpp:239
IToolSvc
The interface implemented by the IToolSvc base class.
Definition: IToolSvc.h:19
UNLIKELY
#define UNLIKELY(x)
Definition: Kernel.h:128
GaudiTool::contextSvc
IAlgContextSvc * contextSvc() const
acessor to the Algorithm Context Service
Definition: GaudiTool.cpp:263
GaudiTool.h
Header file for class GaudiAlgorithm.
GaudiTool::m_isPublic
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:786
GaudiTool::m_ntupleSvc
SmartIF< INTupleSvc > m_ntupleSvc
pointer to the N-Tuple service
Definition: GaudiTool.h:766
GaudiToolLocal::Counter::counts
long counts(const std::string &object)
current count
Definition: GaudiTool.cpp:76
GaudiToolLocal::Counter::report
void report() const
make a report
Definition: GaudiTool.cpp:78
GaudiTool::histoSvc
IHistogramSvc * histoSvc() const
acessor to the histogram service
Definition: GaudiTool.cpp:255
GaudiToolLocal::Counter::Counter
Counter(std::string msg=" Misbalance ")
Definition: GaudiTool.cpp:65
GaudiAlgorithm.h
Header file for class GaudiAlgorithm.
MSG::DEBUG
Definition: IMessageSvc.h:16
std::endl
T endl(T...args)
GaudiToolServices::s_ChronoStatSvc
const std::string s_ChronoStatSvc
the default name for Chrono & Stat Service
Definition: GaudiTool.cpp:47
Bootstrap.h
GaudiTool::m_contextSvc
SmartIF< IAlgContextSvc > m_contextSvc
Algorithm Context Service.
Definition: GaudiTool.h:778
std
STL namespace.
GaudiTool::enableSummary
static bool enableSummary(bool)
enable/disable summary
Definition: GaudiTool.cpp:123
GaudiCommon::finalize
StatusCode finalize() override
standard finalization method
Definition: GaudiCommon.icpp:208
GaudiTool::m_incSvc
SmartIF< IIncidentSvc > m_incSvc
pointer to Incident Service
Definition: GaudiTool.h:774
IDataProviderSvc
Data provider interface definition.
Definition: IDataProviderSvc.h:46
GaudiTool::ntupleSvc
INTupleSvc * ntupleSvc() const
Access the standard N-Tuple.
Definition: GaudiTool.cpp:223
std::map< std::string, long >
StatusCode::isFailure
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:61
GaudiToolServices::s_IncidentSvc
const std::string s_IncidentSvc
the default name for Incident Service
Definition: GaudiTool.cpp:49
GaudiToolServices
Collection of default services names to be used for class GaudiTool.
std::string
STL class.
INTupleSvc
Definition: INTupleSvc.h:37
IChronoStatSvc
The IChronoStatSvc is the interface implemented by the ChronoStatService.
Definition: IChronoStatSvc.h:33
GaudiToolLocal::Counter::m_map
Map m_map
Definition: GaudiTool.cpp:96
GaudiTool::evtColSvc
INTupleSvc * evtColSvc() const
Access the standard event collection service.
Definition: GaudiTool.cpp:231
GaudiToolLocal::Counter::m_message
std::string m_message
Definition: GaudiTool.cpp:97
IDataProviderSvc.h
GaudiToolServices::s_HistoSvc
const std::string s_HistoSvc
the default name for Histogram Service
Definition: GaudiTool.cpp:51
IIncidentSvc.h
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IInterface
Definition of the basic interface.
Definition: IInterface.h:277
AlgTool::service
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:132
GaudiTool::GaudiTool
GaudiTool()=delete
no default/copy constructor, no assignment
GaudiTool::~GaudiTool
~GaudiTool() override
destructor, virtual and protected
Definition: GaudiTool.cpp:147
IHistogramSvc
Definition of the IHistogramSvc interface class.
Definition: IHistogramSvc.h:47
GaudiTool::isPublic
bool isPublic() const
Determines if this tool is public or not (i.e. owned by the ToolSvc).
Definition: GaudiTool.cpp:196
GaudiToolLocal::Counter::increment
long increment(const std::string &object)
make the increment
Definition: GaudiTool.cpp:72
GaudiToolServices::s_DetectorDataSvc
const std::string s_DetectorDataSvc
the default name for Detector Data Service
Definition: GaudiTool.cpp:45
GaudiCommon.icpp
GaudiCommon::initialize
StatusCode initialize() override
standard initialization method
Definition: GaudiCommon.icpp:114
IAlgContextSvc.h
GaudiTool::s_enableSummary
static bool s_enableSummary
enable printout of summary?
Definition: GaudiTool.h:796
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:115
GaudiTool::m_chronoSvc
SmartIF< IChronoStatSvc > m_chronoSvc
pointer to Chrono & Stat Service
Definition: GaudiTool.h:772
GaudiTool::m_histoSvc
SmartIF< IHistogramSvc > m_histoSvc
pointer for histogram service
Definition: GaudiTool.h:776
GaudiToolLocal::Counter
simple local counter
Definition: GaudiTool.cpp:60
AlgTool
Base class from which all the concrete tool classes should be derived.
Definition: AlgTool.h:48
IAlgTool
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
GaudiTool::m_contextSvcName
Gaudi::Property< std::string > m_contextSvcName
Definition: GaudiTool.h:780
AlgTool::parent
const IInterface * parent() const override
Retrieve parent of the sub-algtool.
Definition: AlgTool.cpp:77
GaudiTool::finalize
StatusCode finalize() override
standard finalization method
Definition: GaudiTool.cpp:171
GaudiToolLocal
Definition: GaudiTool.cpp:54
GaudiMP.FdsRegistry.msg
msg
Definition: FdsRegistry.py:8
GaudiTool::m_detSvc
SmartIF< IDataProviderSvc > m_detSvc
pointer to Detector Data Service
Definition: GaudiTool.h:770
GaudiCommon< AlgTool >
GaudiToolServices::s_EventDataSvc
const std::string s_EventDataSvc
the default name for Event Data Service
Definition: GaudiTool.cpp:43
IAlgContextSvc
An abstract interface for Algorithm Context Service.
Definition: IAlgContextSvc.h:23
IChronoStatSvc.h
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:92
GaudiTool::m_local
const std::string m_local
full tool name "type/name"
Definition: GaudiTool.h:791
GaudiTool::m_evtColSvc
SmartIF< INTupleSvc > m_evtColSvc
pointer to the event tag collection service
Definition: GaudiTool.h:768
GaudiToolLocal::Counter::Map
std::map< std::string, long > Map
Definition: GaudiTool.cpp:95
CommonMessagingBase::msgLevel
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
Definition: CommonMessaging.h:124
GaudiToolLocal::Counter::decrement
long decrement(const std::string &object)
make the decrement
Definition: GaudiTool.cpp:74
GaudiCommon< AlgTool >::tool
TOOL * tool(const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
Useful method for the easy location of tools.
std::cout
IAlgTool::parent
virtual const IInterface * parent() const =0
The parent of the concrete AlgTool.
GaudiTool::summaryEnabled
static bool summaryEnabled()
is summary enabled?
Definition: GaudiTool.cpp:131
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
IIncidentSvc
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:23
GaudiTool::initialize
StatusCode initialize() override
standard initialization method
Definition: GaudiTool.cpp:151
GaudiTool::detSvc
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:215
GaudiToolLocal::Counter::~Counter
~Counter()
Definition: GaudiTool.cpp:67
INTupleSvc.h
IHistogramSvc.h