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

GenEvent I/O parsing and serialization for root files. More...

#include <ReaderRoot.h>

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

Public Member Functions

 ReaderRoot (const std::string &filename)
 Default constructor. More...
 
bool skip (const int) override
 skip events More...
 
bool read_event (GenEvent &evt) override
 Read event from file. More...
 
void close () override
 Close file stream. More...
 
bool failed () override
 Get stream error state. More...
 
std::shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object. More...
 
void set_options (const std::map< std::string, std::string > &options)
 Set options. More...
 
std::map< std::string,
std::string > 
get_options () const
 Set options. More...
 

Protected Member Functions

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

Protected Attributes

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

Private Attributes

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

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:
rootIO_example_read.cc.

Definition at line 32 of file ReaderRoot.h.

Constructor & Destructor Documentation

ReaderRoot ( const std::string &  filename)

Default constructor.

Definition at line 17 of file ReaderRoot.cc.

References HEPMC3_ERROR.

Member Function Documentation

void close ( )
overridevirtual

Close file stream.

Implements Reader.

Examples:
rootIO_example_read.cc.

Definition at line 88 of file ReaderRoot.cc.

References ReaderRoot::m_file.

bool failed ( )
overridevirtual

Get stream error state.

Implements Reader.

Examples:
rootIO_example_read.cc.

Definition at line 92 of file ReaderRoot.cc.

References ReaderRoot::m_file.

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

Set options.

Definition at line 58 of file Reader.h.

References Reader::m_options.

bool read_event ( GenEvent evt)
overridevirtual

Read event from file.

Parameters
[out]evtContains parsed event

Implements Reader.

Examples:
rootIO_example_read.cc.

Definition at line 50 of file ReaderRoot.cc.

References HEPMC3_ERROR, HEPMC3_WARNING, ReaderRoot::m_file, ReaderRoot::m_next, GenEvent::read_data(), Reader::run_info(), and GenEvent::set_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.

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.

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.

bool skip ( const int  n)
overridevirtual

skip events

Reimplemented from Reader.

Definition at line 39 of file ReaderRoot.cc.

References GenEvent::clear(), ReaderRoot::failed(), and ReaderRoot::read_event().

Field Documentation

TFile* m_file
private

File handler.

Definition at line 62 of file ReaderRoot.h.

TIter* m_next
private

Iterator for event reading.

Definition at line 63 of file ReaderRoot.h.

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

options

Definition at line 68 of file Reader.h.


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