HepMC3::GenRunInfo Class Reference

Stores run-related information. More...

#include <GenRunInfo.h>

Classes
struct	ToolInfo
	Interrnal struct for keeping track of tools. More...

Public Member Functions
	GenRunInfo ()
	Default constructor.
	GenRunInfo (const GenRunInfo &r)
	Copy constructor.
void	add_attribute (const std::string &name, const std::shared_ptr< Attribute > &att)
	add an attribute This will overwrite existing attribute if an attribute with the same name is present
template<class T>
std::shared_ptr< T >	attribute (const std::string &name) const
	Get attribute of type T.
std::string	attribute_as_string (const std::string &name) const
	Get attribute of any type as string.
std::vector< std::string >	attribute_names () const
	Get list of attribute names.
std::map< std::string, std::shared_ptr< Attribute > >	attributes () const
	Get a copy of the list of attributes.
bool	has_weight (const std::string &name) const
	Check if a weight name is present.
GenRunInfo &	operator= (const GenRunInfo &r)
	Assignmet.
void	remove_attribute (const std::string &name)
	Remove attribute.
void	set_weight_names (const std::vector< std::string > &names)
	Set the names of the weights in this run.
std::vector< ToolInfo > &	tools ()
	The vector of tools used to produce this run.
const std::vector< ToolInfo > &	tools () const
	The vector of tools used to produce this run.
int	weight_index (const std::string &name) const
	Return the index corresponding to a weight name.
std::map< std::string, int >	weight_indices () const
	Returns a copy of indices map.
const std::vector< std::string > &	weight_names () const
	Get the vector of weight names.
Methods to fill GenRunInfoData and to read it back
void	write_data (GenRunInfoData &data) const
	Fill GenRunInfoData object.
void	read_data (const GenRunInfoData &data)
	Fill GenRunInfo based on GenRunInfoData.

Detailed Description

Stores run-related information.

Manages run-related information. Contains run-wide attributes

Definition at line 33 of file GenRunInfo.h.

---

Class Documentation

HepMC3::GenRunInfo::ToolInfo

struct HepMC3::GenRunInfo::ToolInfo

Interrnal struct for keeping track of tools.

Definition at line 38 of file GenRunInfo.h.

Class Members
string	description	Other information about how the tool was used in the run.
string	name	The name of the tool.
string	version	The version of the tool.

Constructor & Destructor Documentation

GenRunInfo() [1/2]

HepMC3::GenRunInfo::GenRunInfo ( )

inline

Default constructor.

Definition at line 54 of file GenRunInfo.h.

{}

Referenced by GenRunInfo(), and operator=().

GenRunInfo() [2/2]

HepMC3::GenRunInfo::GenRunInfo

(

const GenRunInfo &

r

)

Copy constructor.

Definition at line 180 of file marley_hepmc3.cc.

{
    if (this != &r)
    {
        std::lock(m_lock_attributes, r.m_lock_attributes);
        std::lock_guard<std::recursive_mutex> lhs_lk(m_lock_attributes, std::adopt_lock);
        std::lock_guard<std::recursive_mutex> rhs_lk(r.m_lock_attributes, std::adopt_lock);
        GenRunInfoData tdata;
        r.write_data(tdata);
        read_data(tdata);
    }
}

References GenRunInfo(), read_data(), and write_data().

Member Function Documentation

add_attribute()

void HepMC3::GenRunInfo::add_attribute ( const std::string & name, const std::shared_ptr< Attribute > & att )

inline

add an attribute This will overwrite existing attribute if an attribute with the same name is present

Definition at line 102 of file GenRunInfo.h.

                                                            {
        std::lock_guard<std::recursive_mutex> lock(m_lock_attributes);
        if ( att ) m_attributes[name] = att;
    }

Referenced by read_data().

attribute()

template<class T>

std::shared_ptr< T > HepMC3::GenRunInfo::attribute

(

const std::string &

name

)

const

Get attribute of type T.

Definition at line 181 of file GenRunInfo.h.

                                                                  {
    std::lock_guard<std::recursive_mutex> lock(m_lock_attributes);
    std::map< std::string, std::shared_ptr<Attribute> >::iterator i =
        m_attributes.find(name);
    if ( i == m_attributes.end() ) return std::shared_ptr<T>();
 
    if ( !i->second->is_parsed() ) {
 
        std::shared_ptr<T> att = std::make_shared<T>();
        if ( att->from_string(i->second->unparsed_string()) &&
                att->init(*this) ) {
            // update map with new pointer
            i->second = att;
 
            return att;
        }
        else
            return std::shared_ptr<T>();
    }
    else return std::dynamic_pointer_cast<T>(i->second);
}

Referenced by marley::EventFileReader::get_flux_averaged_xsec(), and marley::OutputFile::merge_reweight_provenance_weights().

attribute_as_string()

std::string HepMC3::GenRunInfo::attribute_as_string

(

const std::string &

name

)

const

Get attribute of any type as string.

Definition at line 113 of file marley_hepmc3.cc.

                                                                     {
    std::lock_guard<std::recursive_mutex> lock(m_lock_attributes);
    auto i = m_attributes.find(name);
    if ( i == m_attributes.end() ) return {};
 
    if ( !i->second ) return {};
 
    std::string ret;
    i->second->to_string(ret);
 
    return ret;
}

Referenced by HepMC3::Print::line().

attribute_names()

std::vector< std::string > HepMC3::GenRunInfo::attribute_names

(

)

const

Get list of attribute names.

Definition at line 150 of file marley_hepmc3.cc.

                                                       {
    std::vector<std::string> results;
    results.reserve(m_attributes.size());
    for (const auto& vt1: m_attributes) {
        results.emplace_back(vt1.first);
    }
    return results;
}

Referenced by HepMC3::Print::line().

attributes()

std::map< std::string, std::shared_ptr< Attribute > > HepMC3::GenRunInfo::attributes ( ) const

inline

Get a copy of the list of attributes.

Note

To avoid thread issues, this is returns a copy. Better solution may be needed.

Definition at line 126 of file GenRunInfo.h.

                                                                     {
        return m_attributes;
    }

Referenced by HepMC3::Print::listing().

has_weight()

bool HepMC3::GenRunInfo::has_weight ( const std::string & name ) const

inline

Check if a weight name is present.

Definition at line 72 of file GenRunInfo.h.

                                                 {
        return m_weight_indices.find(name) !=  m_weight_indices.end();
    }

Referenced by set_weight_names().

operator=()

GenRunInfo & HepMC3::GenRunInfo::operator=

(

const GenRunInfo &

r

)

Assignmet.

Definition at line 192 of file marley_hepmc3.cc.

{
    if (this != &r)
    {
        std::lock(m_lock_attributes, r.m_lock_attributes);
        std::lock_guard<std::recursive_mutex> lhs_lk(m_lock_attributes, std::adopt_lock);
        std::lock_guard<std::recursive_mutex> rhs_lk(r.m_lock_attributes, std::adopt_lock);
        GenRunInfoData tdata;
        r.write_data(tdata);
        read_data(tdata);
    }
    return *this;
}

References GenRunInfo(), read_data(), and write_data().

read_data()

void HepMC3::GenRunInfo::read_data

(

const GenRunInfoData &

data

)

Fill GenRunInfo based on GenRunInfoData.

Definition at line 159 of file marley_hepmc3.cc.

                                                     {
    // Weight names
    set_weight_names(data.weight_names);
 
    // Attributes
    for (unsigned int i = 0; i < data.attribute_name.size(); ++i) {
        add_attribute(data.attribute_name[i],
                      std::make_shared<StringAttribute>(data.attribute_string[i]));
    }
 
    // Tools
    for (unsigned int i = 0; i < data.tool_name.size(); ++i) {
        ToolInfo ti;
        ti.name        = data.tool_name[i];
        ti.version     = data.tool_version[i];
        ti.description = data.tool_description[i];
 
        this->tools().emplace_back(ti);
    }
}

References add_attribute(), HepMC3::GenRunInfoData::attribute_name, HepMC3::GenRunInfoData::attribute_string, HepMC3::GenRunInfo::ToolInfo::description, HepMC3::GenRunInfo::ToolInfo::name, set_weight_names(), HepMC3::GenRunInfoData::tool_description, HepMC3::GenRunInfoData::tool_name, HepMC3::GenRunInfoData::tool_version, tools(), HepMC3::GenRunInfo::ToolInfo::version, and HepMC3::GenRunInfoData::weight_names.

Referenced by GenRunInfo(), and operator=().

remove_attribute()

void HepMC3::GenRunInfo::remove_attribute ( const std::string & name )

inline

Remove attribute.

Definition at line 109 of file GenRunInfo.h.

                                                 {
        std::lock_guard<std::recursive_mutex> lock(m_lock_attributes);
        m_attributes.erase(name);
    }

set_weight_names()

void HepMC3::GenRunInfo::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 93 of file marley_hepmc3.cc.

                                                                    {
    m_weight_indices.clear();
    m_weight_names = names;
    for ( int i = 0, N = names.size(); i < N; ++i ) {
        std::string name = names[i];
        if ( name.empty() ) {
            std::ostringstream oss;
            oss << i;
            name = oss.str();
            m_weight_names[i] = name;
        }
        if ( has_weight(name) ) {
            throw std::logic_error("GenRunInfo::set_weight_names: "
                                   "Duplicate weight name '" + name +
                                   "' found.");
        }
        m_weight_indices[name] = i;
    }
}

References has_weight().

Referenced by read_data().

tools() [1/2]

std::vector< ToolInfo > & HepMC3::GenRunInfo::tools ( )

inline

The vector of tools used to produce this run.

Definition at line 67 of file GenRunInfo.h.

                                  {
        return m_tools;
    }

tools() [2/2]

const std::vector< ToolInfo > & HepMC3::GenRunInfo::tools ( ) const

inline

The vector of tools used to produce this run.

Definition at line 63 of file GenRunInfo.h.

                                              {
        return m_tools;
    }

Referenced by HepMC3::Print::line(), HepMC3::Print::listing(), read_data(), and write_data().

weight_index()

int HepMC3::GenRunInfo::weight_index ( const std::string & name ) const

inline

Return the index corresponding to a weight name.

Returns

-1 if name was not found

Definition at line 83 of file GenRunInfo.h.

                                                  {
        std::map<std::string, int>::const_iterator it = m_weight_indices.find(name);
        return it == m_weight_indices.end()? -1: it->second;
    }

weight_indices()

std::map< std::string, int > HepMC3::GenRunInfo::weight_indices ( ) const

inline

Returns a copy of indices map.

Definition at line 77 of file GenRunInfo.h.

                                                  {
        return m_weight_indices;
    }

weight_names()

const std::vector< std::string > & HepMC3::GenRunInfo::weight_names ( ) const

inline

Get the vector of weight names.

Definition at line 89 of file GenRunInfo.h.

                                                      {
        return m_weight_names;
    }

Referenced by HepMC3::Print::listing(), and write_data().

write_data()

void HepMC3::GenRunInfo::write_data

(

GenRunInfoData &

data

)

const

Fill GenRunInfoData object.

Definition at line 126 of file marley_hepmc3.cc.

                                                      {
    // Weight names
    data.weight_names = this->weight_names();
 
    // Attributes
    using att_val_t = std::map<std::string, std::shared_ptr<Attribute>>::value_type;
 
    for (const att_val_t& vt: m_attributes) {
        std::string att;
        vt.second->to_string(att);
 
        data.attribute_name.  emplace_back(vt.first);
        data.attribute_string.emplace_back(att);
    }
 
    // Tools
    for ( const ToolInfo &tool: this->tools() ) {
        data.tool_name.       emplace_back(tool.name);
        data.tool_version.    emplace_back(tool.version);
        data.tool_description.emplace_back(tool.description);
    }
}

References HepMC3::GenRunInfoData::attribute_name, HepMC3::GenRunInfoData::attribute_string, HepMC3::GenRunInfoData::tool_description, HepMC3::GenRunInfoData::tool_name, HepMC3::GenRunInfoData::tool_version, tools(), weight_names(), and HepMC3::GenRunInfoData::weight_names.

Referenced by GenRunInfo(), and operator=().

---

The documentation for this class was generated from the following files:

• /home/sjg/Desktop/marley/include/builtin/HepMC3/GenRunInfo.h
• /home/sjg/Desktop/marley/src/marley_hepmc3.cc