The Gaudi Framework  v29r0 (ff2e7097)
HistorySvc.h
Go to the documentation of this file.
1 #ifndef GAUDISVC_FASTHISTORYSVC_H
2 #define GAUDISVC_FASTHISTORYSVC_H
3 
5 
6 #include "GaudiKernel/AlgTool.h"
10 #include "GaudiKernel/Service.h"
11 #include "GaudiKernel/StatusCode.h"
12 
13 #include "GaudiKernel/ClassID.h"
14 #include "GaudiKernel/MsgStream.h"
15 #include <fstream>
16 #include <map>
17 #include <set>
18 #include <string>
19 #include <vector>
20 
21 class StoreGateSvc;
22 class IAlgContextSvc;
23 class IIncidentSvc;
24 class HistoryObj;
25 class DataHistory;
26 class AlgorithmHistory;
27 class ServiceHistory;
28 struct DHH;
29 
36 class HistorySvc : public extends<Service, IHistorySvc, IIncidentListener>
37 {
38 public:
39  StatusCode initialize() override;
40  StatusCode reinitialize() override;
41  StatusCode finalize() override;
42  StatusCode stop() override;
43 
44  virtual StatusCode captureState();
45 
46  StatusCode registerJob() override;
47  StatusCode listProperties() const override;
48  JobHistory* getJobHistory() const override;
49 
50  StatusCode registerSvc( const IService& ) override;
51  StatusCode listProperties( const IService& ) const override;
52  ServiceHistory* getServiceHistory( const IService& ) const override;
53  void getServiceHistory( std::set<ServiceHistory*>& ) const override;
54 
55  StatusCode registerAlg( const Algorithm& ) override;
56  StatusCode listProperties( const Algorithm& ) const override;
57  AlgorithmHistory* getAlgHistory( const Algorithm& ) const override;
58  void getAlgHistory( std::set<AlgorithmHistory*>& ) const override;
59 
60  StatusCode registerAlgTool( const IAlgTool& ) override;
61  StatusCode listProperties( const IAlgTool& ) const override;
62  AlgToolHistory* getAlgToolHistory( const IAlgTool& ) const override;
63  void getAlgToolHistory( std::set<AlgToolHistory*>& ) const override;
64 
65  DataHistory* createDataHistoryObj( const CLID& id, const std::string& key, const std::string& store ) override;
66  virtual StatusCode registerDataHistory( const CLID& id, const std::string& key, const std::string& store );
67  DataHistory* getDataHistory( const CLID& id, const std::string& key, const std::string& store ) const override;
68  virtual int getDataHistory( const CLID& id, const std::string& key, const std::string& storeName,
69  std::list<DataHistory*>& dhlist ) const;
70 
71  using extends::extends;
72 
73  void handle( const Incident& inc ) override;
74 
75  // Destructor.
76  ~HistorySvc() override = default;
77 
78 private:
79  // typedef std::map<const CLID, std::map<const std::string, DataHistory*> >
80  // DataHistMap;
81 
83 
85  typedef DataHistMap::iterator DHMitr;
86  typedef DataHistMap::const_iterator DHMCitr;
87 
88  Gaudi::Property<bool> m_dump{this, "Dump", false};
89  Gaudi::Property<bool> m_activate{this, "Activate", true};
91 
92  void clearState();
93 
94  bool m_isInitialized = false;
95 
97 
99 
103 
105 
107 
108  void dumpProperties( std::ofstream& ) const;
109  void dumpProperties( const IService&, std::ofstream& ) const;
110  void dumpProperties( const Algorithm&, std::ofstream& ) const;
111  void dumpProperties( const IAlgTool&, std::ofstream& ) const;
112 
113  void dumpState( std::ofstream& ) const;
114  void dumpState( const INamedInterface*, std::ofstream& ) const;
115 
116  std::string dumpProp( const Gaudi::Details::PropertyBase*, const bool isXML = false, int indent = 0 ) const;
117 
118  IAlgorithm* getCurrentIAlg() const;
119 
122 
123  bool m_outputFileTypeXML = false;
124 };
125 
126 #endif
StatusCode reinitialize() override
Definition: HistorySvc.cpp:80
AlgToolHistory * getAlgToolHistory(const IAlgTool &) const override
Definition: HistorySvc.cpp:683
~HistorySvc() override=default
SmartIF< IToolSvc > m_toolSvc
Definition: HistorySvc.h:121
StatusCode registerSvc(const IService &) override
Definition: HistorySvc.cpp:535
Implementation of property with value of concrete type.
Definition: Property.h:319
StatusCode registerAlgTool(const IAlgTool &) override
Definition: HistorySvc.cpp:612
std::string dumpProp(const Gaudi::Details::PropertyBase *, const bool isXML=false, int indent=0) const
Definition: HistorySvc.cpp:713
StatusCode registerAlg(const Algorithm &) override
Definition: HistorySvc.cpp:293
AlgorithmHistory class definition.
StatusCode initialize() override
Definition: HistorySvc.cpp:119
StatusCode listProperties() const override
Definition: HistorySvc.cpp:370
virtual StatusCode registerDataHistory(const CLID &id, const std::string &key, const std::string &store)
Definition: HistorySvc.cpp:471
AlgorithmHistory * getAlgHistory(const Algorithm &) const override
Definition: HistorySvc.cpp:352
StatusCode stop() override
Definition: HistorySvc.cpp:247
HistorySvc class definition.
Definition: HistorySvc.h:36
Base class for History Objects.
Definition: HistoryObj.h:21
std::multimap< DHH, DataHistory * > m_datMap
Definition: HistorySvc.h:104
std::map< const AlgTool *, AlgToolHistory * > m_algtoolmap
Definition: HistorySvc.h:101
JobHistory class definition.
Definition: JobHistory.h:22
IAlgorithm * getCurrentIAlg() const
Definition: HistorySvc.cpp:433
void handle(const Incident &inc) override
Definition: HistorySvc.cpp:701
std::multimap< DHH, DataHistory * > DataHistMap
Definition: HistorySvc.h:84
STL class.
STL class.
Gaudi::Property< bool > m_dump
Definition: HistorySvc.h:88
bool m_isInitialized
Definition: HistorySvc.h:94
JobHistory * getJobHistory() const override
Definition: HistorySvc.cpp:430
General service interface definition.
Definition: IService.h:18
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:28
bool m_outputFileTypeXML
Definition: HistorySvc.h:123
DataHistory class definition.
Definition: DataHistory.h:23
IAlgContextSvc * p_algCtxSvc
Definition: HistorySvc.h:96
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
DataHistMap::const_iterator DHMCitr
Definition: HistorySvc.h:86
STL class.
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:28
StatusCode finalize() override
Definition: HistorySvc.cpp:273
AlgToolHistory class definition.
void dumpState(std::ofstream &) const
Definition: HistorySvc.cpp:731
IIncidentSvc * m_incidentSvc
Definition: HistorySvc.h:120
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:78
IInterface compliant class extending IInterface with the name() method.
STL class.
void dumpProperties(std::ofstream &) const
Definition: HistorySvc.cpp:411
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
DataHistory * createDataHistoryObj(const CLID &id, const std::string &key, const std::string &store) override
Definition: HistorySvc.cpp:443
Base class for all Incidents (computing events).
Definition: Incident.h:17
StatusCode registerJob() override
Definition: HistorySvc.cpp:367
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
ServiceHistory class definition.
std::map< const Algorithm *, AlgorithmHistory * > m_algmap
Definition: HistorySvc.h:98
IVersHistoryObj::PropertyList PropertyList
Definition: HistorySvc.h:82
An abstract interface for Algorithm Context Service.
Gaudi::Property< std::string > m_outputFile
Definition: HistorySvc.h:90
std::set< const IAlgTool * > m_ialgtools
Definition: HistorySvc.h:100
DataHistMap::iterator DHMitr
Definition: HistorySvc.h:85
void clearState()
Definition: HistorySvc.cpp:107
virtual StatusCode captureState()
Definition: HistorySvc.cpp:169
ServiceHistory * getServiceHistory(const IService &) const override
Definition: HistorySvc.cpp:566
std::map< const IService *, ServiceHistory * > m_svcmap
Definition: HistorySvc.h:102
DataHistory * getDataHistory(const CLID &id, const std::string &key, const std::string &store) const override
Definition: HistorySvc.cpp:505
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:23
Gaudi::Property< bool > m_activate
Definition: HistorySvc.h:89
std::unique_ptr< JobHistory > m_jobHistory
Definition: HistorySvc.h:106