ReaderRootTree Class Reference

Detailed Description

GenEvent I/O parsing and serialization for root files based on root TTree.

If HepMC was compiled with path to ROOT available, this class can be used for root file I/O in the same manner as with HepMC::ReaderAscii class.

Examples

convert_example.cc.

Definition at line 34 of file ReaderRootTree.h.

#include <ReaderRootTree.h>

Inheritance diagram for ReaderRootTree:

Collaboration diagram for ReaderRootTree:

Public Member Functions
	ReaderRootTree (const std::string &filename)
	Default constructor.
	ReaderRootTree (const std::string &filename, const std::string &treename, const std::string &branchname)
	Constructor with tree name.
bool	read_event (GenEvent &evt)
	Read event from file.
void	close ()
	Close file.
bool	failed ()
	Get file error state.
shared_ptr< GenRunInfo >	run_info () const
	Get the global GenRunInfo object.

Data Fields
TTree *	m_tree
	Tree handler. Public to allow simple access, e.g. custom branches.

Protected Member Functions
void	set_run_info (shared_ptr< GenRunInfo > run)
	Set the global GenRunInfo object.

Private Member Functions
bool	init ()
	init routine

Private Attributes
TFile *	m_file
	File handler.
int	m_events_count
	Events count. Needed to read the tree.
GenEventData *	m_event_data
	Pointer to structure that holds event data.
GenRunInfoData *	m_run_info_data
	Pointer to structure that holds run info data.
std::string	m_tree_name
	Name of TTree.
std::string	m_branch_name
	Name of TBranch in TTree.
shared_ptr< GenRunInfo >	m_run_info
	The global GenRunInfo object.

Constructor & Destructor Documentation

ReaderRootTree() [1/2]

ReaderRootTree

(

const std::string &

filename

)

Default constructor.

Definition at line 17 of file ReaderRootTree.cc.

References ReaderRootTree::init(), and ReaderRootTree::m_file.

ReaderRootTree() [2/2]

ReaderRootTree	(	const std::string &	filename,
		const std::string &	treename,
		const std::string &	branchname
	)

Constructor with tree name.

Definition at line 25 of file ReaderRootTree.cc.

References ReaderRootTree::init(), and ReaderRootTree::m_file.

Member Function Documentation

close()

void close ( )

virtual

Close file.

Implements Reader.

Definition at line 96 of file ReaderRootTree.cc.

References ReaderRootTree::m_file.

failed()

bool failed ( )

virtual

Get file error state.

Implements Reader.

Definition at line 101 of file ReaderRootTree.cc.

References ReaderRootTree::m_events_count, ReaderRootTree::m_file, and ReaderRootTree::m_tree.

init()

bool init ( )

private

init routine

Definition at line 32 of file ReaderRootTree.cc.

References ERROR, ReaderRootTree::m_branch_name, ReaderRootTree::m_event_data, ReaderRootTree::m_file, ReaderRootTree::m_run_info_data, ReaderRootTree::m_tree, ReaderRootTree::m_tree_name, and Reader::set_run_info().

read_event()

bool read_event ( GenEvent &  evt )

virtual

Read event from file.

Parameters

[out]

evt

Contains parsed event

Implements Reader.

Definition at line 68 of file ReaderRootTree.cc.

References GenEventData::attribute_id, GenEventData::attribute_name, GenRunInfoData::attribute_name, GenEventData::attribute_string, GenRunInfoData::attribute_string, GenEventData::links1, GenEventData::links2, ReaderRootTree::m_event_data, ReaderRootTree::m_events_count, ReaderRootTree::m_run_info_data, ReaderRootTree::m_tree, GenEventData::particles, GenEvent::read_data(), Reader::run_info(), GenEvent::set_run_info(), GenRunInfoData::tool_description, GenRunInfoData::tool_name, GenRunInfoData::tool_version, GenEventData::vertices, and GenRunInfoData::weight_names.

run_info()

shared_ptr< GenRunInfo > run_info ( ) const

inlineinherited

Get the global GenRunInfo object.

Examples

LHEF_example_cat.cc, and convert_example.cc.

Definition at line 39 of file Reader.h.

References Reader::m_run_info.

set_run_info()

void set_run_info ( shared_ptr< GenRunInfo >  run )

inlineprotectedinherited

Set the global GenRunInfo object.

Definition at line 46 of file Reader.h.

References Reader::m_run_info.

Field Documentation

m_branch_name

std::string m_branch_name

private

Name of TBranch in TTree.

Definition at line 77 of file ReaderRootTree.h.

m_event_data

GenEventData* m_event_data

private

Pointer to structure that holds event data.

Definition at line 74 of file ReaderRootTree.h.

m_events_count

int m_events_count

private

Events count. Needed to read the tree.

Definition at line 73 of file ReaderRootTree.h.

m_file

TFile* m_file

private

File handler.

Definition at line 69 of file ReaderRootTree.h.

m_run_info

shared_ptr<GenRunInfo> m_run_info

privateinherited

The global GenRunInfo object.

Definition at line 53 of file Reader.h.

m_run_info_data

GenRunInfoData* m_run_info_data

private

Pointer to structure that holds run info data.

Definition at line 75 of file ReaderRootTree.h.

m_tree

TTree* m_tree

Tree handler. Public to allow simple access, e.g. custom branches.

Definition at line 71 of file ReaderRootTree.h.

m_tree_name

std::string m_tree_name

private

Name of TTree.

Definition at line 76 of file ReaderRootTree.h.

---

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

• ReaderRootTree.h
• ReaderRootTree.cc