|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
#ifndef DataFormats_Provenance_ModuleDescription_h
#define DataFormats_Provenance_ModuleDescription_h
/*----------------------------------------------------------------------
ModuleDescription: The description of a producer module.
----------------------------------------------------------------------*/
#include "DataFormats/Provenance/interface/ParameterSetID.h"
#include "DataFormats/Provenance/interface/ProcessConfiguration.h"
#include <iosfwd>
#include <limits>
#include <string>
namespace edm {
// once a module is born, these parts of the module's product provenance
// are constant (change to ModuleDescription)
class ModuleDescription {
public:
ModuleDescription();
ModuleDescription(std::string const& modName, std::string const& modLabel);
ModuleDescription(std::string const& modName, std::string const& modLabel, ProcessConfiguration const* procConfig);
ModuleDescription(ParameterSetID const& pid, std::string const& modName, std::string const& modLabel);
ModuleDescription(ParameterSetID const& pid,
std::string const& modName,
std::string const& modLabel,
ProcessConfiguration const* procConfig,
unsigned int modID);
~ModuleDescription();
void write(std::ostream& os) const;
ParameterSetID const& parameterSetID() const { return parameterSetID_; }
std::string const& moduleName() const { return moduleName_; }
std::string const& moduleLabel() const { return moduleLabel_; }
///A unique ID for a module declared in the Process. The id is only unique for the Process and not across different Processes.
///If the id is invalid, will return the max unsigned int value.
unsigned int id() const { return id_; }
ProcessConfiguration const& processConfiguration() const;
std::string const& processName() const;
std::string const& releaseVersion() const;
ParameterSetID const& mainParameterSetID() const;
// compiler-written copy c'tor, assignment, and d'tor are correct.
bool operator<(ModuleDescription const& rh) const;
bool operator==(ModuleDescription const& rh) const;
bool operator!=(ModuleDescription const& rh) const;
///Returns a unique id each time called. Intended to be passed to ModuleDescription's constructor's modID argument. Thread safe.
static unsigned int getUniqueID();
///Returns a value identifying an invalid id (the max unsigned int value)
static constexpr unsigned int invalidID() { return std::numeric_limits<unsigned int>::max(); }
private:
// ID of parameter set of the creator
ParameterSetID parameterSetID_;
// The class name of the creator
std::string moduleName_;
// A human friendly string that uniquely identifies the EDProducer
// and becomes part of the identity of a product that it produces
std::string moduleLabel_;
// The process configuration.
ProcessConfiguration const* processConfigurationPtr_;
unsigned int id_;
};
inline std::ostream& operator<<(std::ostream& os, ModuleDescription const& p) {
p.write(os);
return os;
}
} // namespace edm
#endif
|