HistorySvc.h
Go to the documentation of this file.
1 #ifndef GAUDISVC_FASTHISTORYSVC_H
2 #define GAUDISVC_FASTHISTORYSVC_H
3 
5 
6 #ifndef GAUDIKERNEL_SERVICE_H
7  #include "GaudiKernel/Service.h"
8 #endif
9 #ifndef KERNEL_STATUSCODES_H
10  #include "GaudiKernel/StatusCode.h"
11 #endif
12 
13 #include "GaudiKernel/Algorithm.h"
14 #include "GaudiKernel/AlgTool.h"
17 
18 #include <vector>
19 #include <string>
20 #include <set>
21 #include <map>
22 #include <fstream>
23 #include "GaudiKernel/ClassID.h"
24 #include "GaudiKernel/MsgStream.h"
25 
26 class StoreGateSvc;
27 class IAlgContextSvc;
28 class IIncidentSvc;
29 class HistoryObj;
30 class DataHistory;
31 class AlgorithmHistory;
32 class ServiceHistory;
33 struct DHH;
34 
41 class HistorySvc: public extends<Service,
42  IHistorySvc,
43  IIncidentListener> {
44 public:
45 
46  virtual StatusCode initialize();
47  virtual StatusCode reinitialize();
48  virtual StatusCode finalize();
49  virtual StatusCode stop();
50 
51  virtual StatusCode captureState();
52 
53  virtual StatusCode registerJob();
54  virtual StatusCode listProperties() const;
55  virtual JobHistory* getJobHistory() const;
56 
57  virtual StatusCode registerSvc(const IService&);
58  virtual StatusCode listProperties(const IService&) const;
59  virtual ServiceHistory* getServiceHistory(const IService&) const;
60  virtual void getServiceHistory(std::set<ServiceHistory*>&) const;
61 
62  virtual StatusCode registerAlg(const Algorithm&);
63  virtual StatusCode listProperties(const Algorithm&) const;
64  virtual AlgorithmHistory* getAlgHistory(const Algorithm&) const;
65  virtual void getAlgHistory(std::set<AlgorithmHistory*>&) const;
66 
67  virtual StatusCode registerAlgTool(const IAlgTool&);
68  virtual StatusCode listProperties(const IAlgTool&) const;
69  virtual AlgToolHistory* getAlgToolHistory(const IAlgTool&) const;
70  virtual void getAlgToolHistory(std::set<AlgToolHistory*>&) const;
71 
72  virtual DataHistory* createDataHistoryObj(const CLID& id,
73  const std::string& key,
74  const std::string& store);
75  virtual StatusCode registerDataHistory(const CLID& id,
76  const std::string& key,
77  const std::string& store);
78  virtual DataHistory* getDataHistory(const CLID& id, const std::string& key,
79  const std::string& store) const;
80  virtual int getDataHistory(const CLID& id, const std::string& key,
81  const std::string& storeName,
82  std::list<DataHistory*>& dhlist) const;
83 
84  HistorySvc( const std::string& name, ISvcLocator* svc );
85 
86  virtual void handle(const Incident& inc);
87 
88  // Destructor.
89  virtual ~HistorySvc() = default;
90 
91 private:
92 
93 // typedef std::map<const CLID, std::map<const std::string, DataHistory*> >
94 // DataHistMap;
95 
97 
99  typedef DataHistMap::iterator DHMitr;
100  typedef DataHistMap::const_iterator DHMCitr;
101 
102  void clearState();
103 
104  bool m_isInitialized = false;
105  bool m_dump = false;
106  bool m_activate = true;
107 
109 
111 
115 
117 
118 // std::set<DataHistory*, DataHistory::DataHistoryOrder> m_datMap;
119 
121 
123 
124  void dumpProperties(std::ofstream&) const;
125  void dumpProperties(const IService&, std::ofstream&) const;
126  void dumpProperties(const Algorithm&, std::ofstream&) const;
127  void dumpProperties(const IAlgTool&, std::ofstream&) const;
128 
129  void dumpState(std::ofstream&) const;
130  void dumpState(const INamedInterface*, std::ofstream&) const;
131 
132  std::string dumpProp(const Property*, const bool isXML=false,
133  int indent=0) const;
134 
135  IAlgorithm* getCurrentIAlg() const;
136 
139 
140  mutable MsgStream m_log;
141  bool m_outputFileTypeXML = false;
142 
143 };
144 
145 #endif
virtual StatusCode stop()
Definition: HistorySvc.cpp:271
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
virtual ServiceHistory * getServiceHistory(const IService &) const
Definition: HistorySvc.cpp:632
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
SmartIF< IToolSvc > m_toolSvc
Definition: HistorySvc.h:138
AlgorithmHistory class definition.
virtual StatusCode registerDataHistory(const CLID &id, const std::string &key, const std::string &store)
Definition: HistorySvc.cpp:529
virtual StatusCode listProperties() const
Definition: HistorySvc.cpp:412
virtual StatusCode registerJob()
Definition: HistorySvc.cpp:401
HistorySvc class definition.
Definition: HistorySvc.h:41
Base class for History Objects.
Definition: HistoryObj.h:22
std::multimap< DHH, DataHistory * > DataHistMap
Definition: HistorySvc.h:98
std::multimap< DHH, DataHistory * > m_datMap
Definition: HistorySvc.h:116
std::map< const AlgTool *, AlgToolHistory * > m_algtoolmap
Definition: HistorySvc.h:113
JobHistory class definition.
Definition: JobHistory.h:24
std::string m_outputFile
Definition: HistorySvc.h:122
IAlgorithm * getCurrentIAlg() const
Definition: HistorySvc.cpp:484
STL class.
virtual AlgToolHistory * getAlgToolHistory(const IAlgTool &) const
Definition: HistorySvc.cpp:759
virtual void handle(const Incident &inc)
Definition: HistorySvc.cpp:782
bool m_activate
Definition: HistorySvc.h:106
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:319
STL class.
bool m_isInitialized
Definition: HistorySvc.h:104
General service interface definition.
Definition: IService.h:18
virtual StatusCode registerSvc(const IService &)
Definition: HistorySvc.cpp:600
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
HistorySvc(const std::string &name, ISvcLocator *svc)
Definition: HistorySvc.cpp:76
bool m_outputFileTypeXML
Definition: HistorySvc.h:141
virtual StatusCode registerAlgTool(const IAlgTool &)
Definition: HistorySvc.cpp:684
DataHistory class definition.
Definition: DataHistory.h:23
IAlgContextSvc * p_algCtxSvc
Definition: HistorySvc.h:108
virtual StatusCode registerAlg(const Algorithm &)
Definition: HistorySvc.cpp:320
virtual StatusCode initialize()
Definition: HistorySvc.cpp:127
virtual AlgorithmHistory * getAlgHistory(const Algorithm &) const
Definition: HistorySvc.cpp:381
virtual StatusCode finalize()
Definition: HistorySvc.cpp:298
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
DataHistMap::const_iterator DHMCitr
Definition: HistorySvc.h:100
STL class.
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:25
MsgStream m_log
Definition: HistorySvc.h:140
std::string dumpProp(const Property *, const bool isXML=false, int indent=0) const
Definition: HistorySvc.cpp:797
AlgToolHistory class definition.
void dumpState(std::ofstream &) const
Definition: HistorySvc.cpp:817
IIncidentSvc * m_incidentSvc
Definition: HistorySvc.h:137
virtual DataHistory * createDataHistoryObj(const CLID &id, const std::string &key, const std::string &store)
Definition: HistorySvc.cpp:495
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:74
IInterface compliant class extending IInterface with the name() method.
STL class.
Property base class allowing Property* collections to be "homogeneous".
Definition: Property.h:38
virtual DataHistory * getDataHistory(const CLID &id, const std::string &key, const std::string &store) const
Definition: HistorySvc.cpp:566
void dumpProperties(std::ofstream &) const
Definition: HistorySvc.cpp:456
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
Base class for all Incidents (computing events).
Definition: Incident.h:17
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:110
IVersHistoryObj::PropertyList PropertyList
Definition: HistorySvc.h:96
An abstract interface for Algorithm Context Service.
bool m_dump
Definition: HistorySvc.h:105
virtual ~HistorySvc()=default
std::set< const IAlgTool * > m_ialgtools
Definition: HistorySvc.h:112
DataHistMap::iterator DHMitr
Definition: HistorySvc.h:99
void clearState()
Definition: HistorySvc.cpp:115
virtual StatusCode captureState()
Definition: HistorySvc.cpp:184
std::map< const IService *, ServiceHistory * > m_svcmap
Definition: HistorySvc.h:114
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:21
virtual StatusCode reinitialize()
Definition: HistorySvc.cpp:91
virtual JobHistory * getJobHistory() const
Definition: HistorySvc.cpp:476
std::unique_ptr< JobHistory > m_jobHistory
Definition: HistorySvc.h:120