HepMC event record
|
Stores run-related information.
Manages run-related information. Contains run-wide attributes
Definition at line 33 of file build/outputs/include/HepMC/GenRunInfo.h.
#include <GenRunInfo.h>
Data Structures | |
struct | ToolInfo |
Interrnal struct for keeping track of tools. More... | |
Public Member Functions | |
GenRunInfo () | |
Default constructor. More... | |
const std::vector< ToolInfo > & | tools () const |
The vector of tools used to produce this run. More... | |
std::vector< ToolInfo > & | tools () |
The vector of tools used to produce this run. More... | |
bool | has_weight (string name) const |
Check if a weight name is present. More... | |
int | weight_index (string name) const |
Return the index corresponding to a weight name. More... | |
const std::vector< std::string > & | weight_names () const |
Get the vector of weight names. More... | |
void | set_weight_names (const std::vector< std::string > &names) |
Set the names of the weights in this run. More... | |
void | add_attribute (const string &name, const shared_ptr< Attribute > &att) |
add an attribute This will overwrite existing attribute if an attribute with the same name is present More... | |
void | remove_attribute (const string &name) |
Remove attribute. More... | |
template<class T > | |
shared_ptr< T > | attribute (const string &name) const |
Get attribute of type T. More... | |
string | attribute_as_string (const string &name) const |
Get attribute of any type as string. More... | |
const std::map< std::string, shared_ptr< Attribute > > & | attributes () const |
Get list of attributes. More... | |
GenRunInfo () | |
Default constructor. More... | |
const std::vector< ToolInfo > & | tools () const |
The vector of tools used to produce this run. More... | |
std::vector< ToolInfo > & | tools () |
The vector of tools used to produce this run. More... | |
bool | has_weight (string name) const |
Check if a weight name is present. More... | |
int | weight_index (string name) const |
Return the index corresponding to a weight name. More... | |
const std::vector< std::string > & | weight_names () const |
Get the vector of weight names. More... | |
void | set_weight_names (const std::vector< std::string > &names) |
Set the names of the weights in this run. More... | |
void | add_attribute (const string &name, const shared_ptr< Attribute > &att) |
add an attribute This will overwrite existing attribute if an attribute with the same name is present More... | |
void | remove_attribute (const string &name) |
Remove attribute. More... | |
template<class T > | |
shared_ptr< T > | attribute (const string &name) const |
Get attribute of type T. More... | |
string | attribute_as_string (const string &name) const |
Get attribute of any type as string. More... | |
const std::map< std::string, shared_ptr< Attribute > > & | attributes () const |
Get list of attributes. More... | |
Methods to fill GenRunInfoData and to read it back | |
void | write_data (GenRunInfoData &data) const |
Fill GenRunInfoData object. More... | |
void | read_data (const GenRunInfoData &data) |
Fill GenRunInfo based on GenRunInfoData. More... | |
void | write_data (GenRunInfoData &data) const |
Fill GenRunInfoData object. More... | |
void | read_data (const GenRunInfoData &data) |
Fill GenRunInfo based on GenRunInfoData. More... | |
Private Attributes | |
Fields | |
std::vector< ToolInfo > | m_tools |
The vector of tools used to produce this run. More... | |
std::map< std::string, int > | m_weight_indices |
A map of weight names mapping to indices. More... | |
std::vector< std::string > | m_weight_names |
A vector of weight names. More... | |
std::map< std::string, shared_ptr< Attribute > > | m_attributes |
Map of attributes. More... | |
|
inline |
Default constructor.
Definition at line 54 of file build/outputs/include/HepMC/GenRunInfo.h.
|
inline |
Default constructor.
Definition at line 54 of file include/HepMC/GenRunInfo.h.
|
inline |
add an attribute This will overwrite existing attribute if an attribute with the same name is present
Definition at line 94 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
|
inline |
add an attribute This will overwrite existing attribute if an attribute with the same name is present
Definition at line 94 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
shared_ptr< T > attribute | ( | const string & | name | ) | const |
Get attribute of type T.
Definition at line 163 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
shared_ptr<T> attribute | ( | const string & | name | ) | const |
Get attribute of type T.
string attribute_as_string | ( | const string & | name | ) | const |
Get attribute of any type as string.
Definition at line 37 of file GenRunInfo.cc.
References GenRunInfo::m_attributes.
string attribute_as_string | ( | const string & | name | ) | const |
Get attribute of any type as string.
|
inline |
Get list of attributes.
Definition at line 112 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
|
inline |
Get list of attributes.
Definition at line 112 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
|
inline |
Check if a weight name is present.
Definition at line 68 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_indices.
|
inline |
Check if a weight name is present.
Definition at line 68 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_indices.
void read_data | ( | const GenRunInfoData & | data | ) |
Fill GenRunInfo based on GenRunInfoData.
Definition at line 74 of file GenRunInfo.cc.
References GenRunInfo::add_attribute(), GenRunInfoData::attribute_name, GenRunInfoData::attribute_string, GenRunInfo::ToolInfo::description, GenRunInfo::ToolInfo::name, GenRunInfo::set_weight_names(), GenRunInfoData::tool_description, GenRunInfoData::tool_name, GenRunInfoData::tool_version, GenRunInfo::tools(), GenRunInfo::ToolInfo::version, and GenRunInfoData::weight_names.
void read_data | ( | const GenRunInfoData & | data | ) |
Fill GenRunInfo based on GenRunInfoData.
|
inline |
Remove attribute.
Definition at line 100 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
|
inline |
Remove attribute.
Definition at line 100 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_attributes.
void set_weight_names | ( | const std::vector< std::string > & | names | ) |
Set the names of the weights in this run.
For consistency, the length of the vector should be the same as the number of weights in the events in the run.
void set_weight_names | ( | const std::vector< std::string > & | names | ) |
Set the names of the weights in this run.
For consistency, the length of the vector should be the same as the number of weights in the events in the run.
Definition at line 18 of file GenRunInfo.cc.
References GenRunInfo::has_weight(), GenRunInfo::m_weight_indices, and GenRunInfo::m_weight_names.
|
inline |
The vector of tools used to produce this run.
Definition at line 59 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_tools.
|
inline |
The vector of tools used to produce this run.
Definition at line 59 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_tools.
|
inline |
The vector of tools used to produce this run.
Definition at line 63 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_tools.
|
inline |
The vector of tools used to produce this run.
Definition at line 63 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_tools.
|
inline |
Return the index corresponding to a weight name.
Definition at line 75 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_indices.
|
inline |
Return the index corresponding to a weight name.
Definition at line 75 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_indices.
|
inline |
Get the vector of weight names.
Definition at line 81 of file include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_names.
|
inline |
Get the vector of weight names.
Definition at line 81 of file build/outputs/include/HepMC/GenRunInfo.h.
References GenRunInfo::m_weight_names.
void write_data | ( | GenRunInfoData & | data | ) | const |
Fill GenRunInfoData object.
Definition at line 50 of file GenRunInfo.cc.
References GenRunInfoData::attribute_name, GenRunInfoData::attribute_string, GenRunInfo::attributes(), GenRunInfo::ToolInfo::description, GenRunInfo::ToolInfo::name, GenRunInfoData::tool_description, GenRunInfoData::tool_name, GenRunInfoData::tool_version, GenRunInfo::tools(), GenRunInfo::ToolInfo::version, GenRunInfoData::weight_names, and GenRunInfo::weight_names().
void write_data | ( | GenRunInfoData & | data | ) | const |
Fill GenRunInfoData object.
|
mutableprivate |
Map of attributes.
Definition at line 150 of file build/outputs/include/HepMC/GenRunInfo.h.
|
private |
The vector of tools used to produce this run.
Definition at line 141 of file build/outputs/include/HepMC/GenRunInfo.h.
|
private |
A map of weight names mapping to indices.
Definition at line 144 of file build/outputs/include/HepMC/GenRunInfo.h.
|
private |
A vector of weight names.
Definition at line 147 of file build/outputs/include/HepMC/GenRunInfo.h.