| The Gaudi Framework v29r0 (ff2e7097)

- 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 <string>
11 #include <vector>
12
21 class GAUDI_API AlgToolHistory : public HistoryObj, public IVersHistoryObj
22 {
23
24 private: // data
25 // Algtool full type.
26 std::string m_type;
27
28 // Algtool version.
29 std::string m_version;
30
31 // Algtool name.
32 std::string m_name;
33
34 // Pointer to the algtool
35 const AlgTool* m_tool;
36
37 // Properties.
38 PropertyList m_properties;
39
40 // Link to jobHistory
41 const JobHistory* m_jobHistory;
42
43 public:
44 AlgToolHistory( const AlgTool& alg, const JobHistory* job );
45
46 AlgToolHistory( const std::string& algVersion, const std::string& algName, const std::string& algType,
47 const AlgTool* tool, const PropertyList& props, const JobHistory* job );
48
49 // Destructor.
50 virtual ~AlgToolHistory() override {}
51
52 // Class IDs
53 const CLID& clID() const override { return classID(); }
54 static const CLID& classID();
55
56 // Return the algtool type.
57 const std::string& algtool_type() const { return m_type; }
58
59 // Return the algtool version.
60 const std::string& algtool_version() const { return m_version; }
61
62 // Return the algtool name.
63 const std::string& algtool_name() const { return m_name; }
64
65 // Pointer to the algtool
66 const AlgTool* algtool_instance() const { return m_tool; }
67
68 // Return the algorithm properties.
69 const PropertyList& properties() const override { return m_properties; }
70
71 // Return the jobHistory
72 const JobHistory* jobHistory() const { return m_jobHistory; }
73
74 void dump( std::ostream&, const bool isXML = false, int indent = 0 ) const override;
75
76 const std::string& name() const override { return algtool_name(); }
77 const std::string& type() const override { return algtool_type(); }
78 const std::string& version() const override { return algtool_version(); }
79 };
80
81 // Output stream.
82 GAUDI_API std::ostream& operator<<( std::ostream& lhs, const AlgToolHistory& rhs );
83
84 #endif
AlgToolHistory::~AlgToolHistory
virtual ~AlgToolHistory() override
Definition: AlgToolHistory.h:50
AlgToolHistory::m_version
std::string m_version
Definition: AlgToolHistory.h:29
AlgToolHistory::m_jobHistory
const JobHistory * m_jobHistory
Definition: AlgToolHistory.h:41
AlgToolHistory::m_name
std::string m_name
Definition: AlgToolHistory.h:32
AlgToolHistory::m_properties
PropertyList m_properties
Definition: AlgToolHistory.h:38
AlgToolHistory::algtool_instance
const AlgTool * algtool_instance() const
Definition: AlgToolHistory.h:66
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:72
AlgToolHistory::type
const std::string & type() const override
Definition: AlgToolHistory.h:77
AlgToolHistory::version
const std::string & version() const override
Definition: AlgToolHistory.h:78
AlgToolHistory::m_type
std::string m_type
Definition: AlgToolHistory.h:26
std::string
STL class.
DataObject::m_version
unsigned char m_version
Version number.
Definition: DataObject.h:35
AlgToolHistory::m_tool
const AlgTool * m_tool
Definition: AlgToolHistory.h:35
AlgToolHistory::properties
const PropertyList & properties() const override
Definition: AlgToolHistory.h:69
AlgToolHistory::algtool_type
const std::string & algtool_type() const
Definition: AlgToolHistory.h:57
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
AlgToolHistory
AlgToolHistory class definition.
Definition: AlgToolHistory.h:21
DataObject::operator<<
friend std::ostream & operator<<(std::ostream &s, const DataObject &obj)
Output operator (ASCII)
Definition: DataObject.h:88
AlgToolHistory::clID
const CLID & clID() const override
Retrieve reference to class definition structure.
Definition: AlgToolHistory.h:53
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:76
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:60
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:63