| The Gaudi Framework v30r0 (c919700c)

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

- File List
- File Members

AlgToolHistory.h
Go to the documentation of this file.
1 #ifndef GAUDIKERNEL_ALGTOOLHISTORY_H
2 #define GAUDIKERNEL_ALGTOOLHISTORY_H
3
4 #include "GaudiKernel/HistoryObj.h"
5 #include "GaudiKernel/IVersHistoryObj.h"
6
7 class AlgTool;
8 class JobHistory;
9
10 #include <memory>
11 #include <string>
12 #include <vector>
13
22 class GAUDI_API AlgToolHistory : public HistoryObj, public IVersHistoryObj
23 {
24
25 private: // data
26 // Algtool full type.
27 std::string m_type;
28
29 // Algtool version.
30 std::string m_version;
31
32 // Algtool name.
33 std::string m_name;
34
35 // Pointer to the algtool
36 const AlgTool* m_tool;
37
38 // Properties.
39 PropertyList m_properties;
40
41 // Link to jobHistory
42 const JobHistory* m_jobHistory;
43
44 public:
45 AlgToolHistory( const AlgTool& alg, const JobHistory* job );
46
47 AlgToolHistory( const std::string& algVersion, const std::string& algName, const std::string& algType,
48 const AlgTool* tool, const PropertyList& props, const JobHistory* job );
49
50 // Destructor.
51 virtual ~AlgToolHistory() override {}
52
53 // Class IDs
54 const CLID& clID() const override { return classID(); }
55 static const CLID& classID();
56
57 // Return the algtool type.
58 const std::string& algtool_type() const { return m_type; }
59
60 // Return the algtool version.
61 const std::string& algtool_version() const { return m_version; }
62
63 // Return the algtool name.
64 const std::string& algtool_name() const { return m_name; }
65
66 // Pointer to the algtool
67 const AlgTool* algtool_instance() const { return m_tool; }
68
69 // Return the algorithm properties.
70 const PropertyList& properties() const override { return m_properties; }
71
72 // Return the jobHistory
73 const JobHistory* jobHistory() const { return m_jobHistory; }
74
75 void dump( std::ostream&, const bool isXML = false, int indent = 0 ) const override;
76
77 const std::string& name() const override { return algtool_name(); }
78 const std::string& type() const override { return algtool_type(); }
79 const std::string& version() const override { return algtool_version(); }
80 };
81
82 // Output stream.
83 GAUDI_API std::ostream& operator<<( std::ostream& lhs, const AlgToolHistory& rhs );
84
85 #endif
AlgToolHistory::~AlgToolHistory
virtual ~AlgToolHistory() override
Definition: AlgToolHistory.h:51
AlgToolHistory::m_version
std::string m_version
Definition: AlgToolHistory.h:30
AlgToolHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: AlgToolHistory.h:42
AlgToolHistory::m_name
std::string m_name
Definition: AlgToolHistory.h:33
AlgToolHistory::m_properties
PropertyList m_properties
Definition: AlgToolHistory.h:39
AlgToolHistory::algtool_instance
const AlgTool * algtool_instance() const
Definition: AlgToolHistory.h:67
HistoryObj::classID
static const CLID & classID()
Definition: HistoryObj.cpp:59
PropertyList
List of properties.
Definition: PropertyList.h:16
HistoryObj::dump
virtual void dump(std::ostream &, const bool isXML=false, int indent=0) const =0
HistoryObj
Base class for History Objects.
Definition: HistoryObj.h:21
HistoryObj.h
JobHistory
JobHistory class definition.
Definition: JobHistory.h:22
IVersHistoryObj.h
AlgToolHistory::jobHistory
const JobHistory * jobHistory() const
Definition: AlgToolHistory.h:73
AlgToolHistory::type
const std::string & type() const override
Definition: AlgToolHistory.h:78
AlgToolHistory::version
const std::string & version() const override
Definition: AlgToolHistory.h:79
AlgToolHistory::m_type
std::string m_type
Definition: AlgToolHistory.h:27
std::string
STL class.
DataObject::m_version
unsigned char m_version
Version number.
Definition: DataObject.h:36
AlgToolHistory::m_tool
const AlgTool * m_tool
Definition: AlgToolHistory.h:36
AlgToolHistory::properties
const PropertyList & properties() const override
Definition: AlgToolHistory.h:70
AlgToolHistory::algtool_type
const std::string & algtool_type() const
Definition: AlgToolHistory.h:58
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
AlgToolHistory
AlgToolHistory class definition.
Definition: AlgToolHistory.h:22
DataObject::operator<<
friend std::ostream & operator<<(std::ostream &s, const DataObject &obj)
Output operator (ASCII)
Definition: DataObject.h:89
AlgToolHistory::clID
const CLID & clID() const override
Retrieve reference to class definition structure.
Definition: AlgToolHistory.h:54
AlgTool
Base class from which all the concrete tool classes should be derived.
Definition: AlgTool.h:48
AlgToolHistory::name
const std::string & name() const override
Definition: AlgToolHistory.h:77
m_properties
Properties m_properties
Collection of all declared properties.
Definition: PropertyMgr.h:139
AlgToolHistory::algtool_version
const std::string & algtool_version() const
Definition: AlgToolHistory.h:61
IVersHistoryObj
Interface for Versioned History Objects.
Definition: IVersHistoryObj.h:18
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:110
std::ostream
STL class.
AlgToolHistory::algtool_name
const std::string & algtool_name() const
Definition: AlgToolHistory.h:64