HepMC3 event record library
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
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.

Definition at line 35 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 skip (const int) override
 skip events
 
bool read_event (GenEvent &evt) override
 Read event from file.
 
void close () override
 Close file.
 
bool failed () override
 Get file error state.
 
std::shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object.
 
void set_options (const std::map< std::string, std::string > &options)
 Set options.
 
std::map< std::string, std::string > get_options () const
 Set options.
 

Data Fields

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

Protected Member Functions

void set_run_info (std::shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object.
 

Protected Attributes

std::map< std::string, std::string > m_options
 options
 

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.
 
GenEventDatam_event_data
 Pointer to structure that holds event data.
 
GenRunInfoDatam_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.
 
std::shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object.
 

Constructor & Destructor Documentation

◆ ReaderRootTree() [1/2]

ReaderRootTree ( const std::string &  filename)

Default constructor.

Definition at line 18 of file ReaderRootTree.cc.

◆ ReaderRootTree() [2/2]

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

Constructor with tree name.

Definition at line 26 of file ReaderRootTree.cc.

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

Member Function Documentation

◆ close()

void close ( )
overridevirtual

Close file.

Implements Reader.

Definition at line 113 of file ReaderRootTree.cc.

References ReaderRootTree::m_file.

◆ failed()

bool failed ( )
overridevirtual

Get file error state.

Implements Reader.

Definition at line 118 of file ReaderRootTree.cc.

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

◆ get_options()

std::map< std::string, std::string > get_options ( ) const
inlineinherited

Set options.

Definition at line 58 of file Reader.h.

References Reader::m_options.

◆ init()

bool init ( )
private

◆ read_event()

bool read_event ( GenEvent evt)
overridevirtual

◆ run_info()

std::shared_ptr< GenRunInfo > run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Examples
LHEF_example_cat.cc.

Definition at line 44 of file Reader.h.

References Reader::m_run_info.

◆ set_options()

void set_options ( const std::map< std::string, std::string > &  options)
inlineinherited

Set options.

Definition at line 53 of file Reader.h.

References Reader::m_options.

◆ set_run_info()

void set_run_info ( std::shared_ptr< GenRunInfo run)
inlineprotectedinherited

Set the global GenRunInfo object.

Definition at line 64 of file Reader.h.

References Reader::m_run_info.

◆ skip()

bool skip ( const int  n)
overridevirtual

skip events

Reimplemented from Reader.

Definition at line 76 of file ReaderRootTree.cc.

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

Field Documentation

◆ m_branch_name

std::string m_branch_name
private

Name of TBranch in TTree.

Definition at line 80 of file ReaderRootTree.h.

◆ m_event_data

GenEventData* m_event_data
private

Pointer to structure that holds event data.

Definition at line 77 of file ReaderRootTree.h.

◆ m_events_count

int m_events_count
private

Events count. Needed to read the tree.

Definition at line 76 of file ReaderRootTree.h.

◆ m_file

TFile* m_file
private

File handler.

Definition at line 72 of file ReaderRootTree.h.

◆ m_options

std::map<std::string, std::string> m_options
protectedinherited

options

Definition at line 68 of file Reader.h.

◆ m_run_info

std::shared_ptr<GenRunInfo> m_run_info
privateinherited

The global GenRunInfo object.

Definition at line 71 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 78 of file ReaderRootTree.h.

◆ m_tree

TTree* m_tree

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

Definition at line 74 of file ReaderRootTree.h.

◆ m_tree_name

std::string m_tree_name
private

Name of TTree.

Definition at line 79 of file ReaderRootTree.h.


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