HepMC3 event record library
Public Member Functions | Protected Member Functions | Private Attributes
ReaderRoot Class Reference

Detailed Description

GenEvent I/O parsing and serialization for root files.

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, and rootIO_example_read.cc.

Definition at line 32 of file ReaderRoot.h.

#include <ReaderRoot.h>

+ Inheritance diagram for ReaderRoot:
+ Collaboration diagram for ReaderRoot:

Public Member Functions

 ReaderRoot (const std::string &filename)
 Default constructor. More...
 
bool read_event (GenEvent &evt)
 Read event from file. More...
 
void close ()
 Close file stream. More...
 
bool failed ()
 Get stream error state. More...
 
shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object. More...
 

Protected Member Functions

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

Private Attributes

TFile * m_file
 File handler. More...
 
TIter * m_next
 Iterator for event reading. More...
 

Constructor & Destructor Documentation

◆ ReaderRoot()

ReaderRoot ( const std::string &  filename)

Default constructor.

Definition at line 15 of file ReaderRoot.cc.

References ERROR, ReaderRoot::m_file, ReaderRoot::m_next, and Reader::set_run_info().

Member Function Documentation

◆ close()

void close ( )
virtual

Close file stream.

Implements Reader.

Examples
rootIO_example_read.cc.

Definition at line 75 of file ReaderRoot.cc.

References ReaderRoot::m_file.

◆ failed()

bool failed ( )
virtual

Get stream error state.

Implements Reader.

Examples
rootIO_example_read.cc.

Definition at line 79 of file ReaderRoot.cc.

References ReaderRoot::m_file.

◆ read_event()

bool read_event ( GenEvent evt)
virtual

Read event from file.

Parameters
[out]evtContains parsed event

Implements Reader.

Examples
rootIO_example_read.cc.

Definition at line 37 of file ReaderRoot.cc.

References ERROR, ReaderRoot::m_file, ReaderRoot::m_next, GenEvent::read_data(), Reader::run_info(), GenEvent::set_run_info(), and WARNING.

◆ run_info()

shared_ptr<GenRunInfo> run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Examples
convert_example.cc, and LHEF_example_cat.cc.

Definition at line 37 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 44 of file Reader.h.

References Reader::m_run_info.

Field Documentation

◆ m_file

TFile* m_file
private

File handler.

Definition at line 60 of file ReaderRoot.h.

◆ m_next

TIter* m_next
private

Iterator for event reading.

Definition at line 61 of file ReaderRoot.h.


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