HepMC event record
Public Member Functions | Protected Member Functions | Private Attributes
Reader Class Referenceabstract

Detailed Description

Base class for all I/O readers.

Definition at line 25 of file build/outputs/include/HepMC/Reader.h.

#include <Reader.h>

+ Inheritance diagram for Reader:

Public Member Functions

virtual ~Reader ()
 Virtual destructor. More...
 
virtual bool read_event (GenEvent &evt)=0
 Fill next event from input into evt. More...
 
virtual bool failed ()=0
 
virtual void close ()=0
 
shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object. More...
 
virtual ~Reader ()
 Virtual destructor. More...
 
virtual bool read_event (GenEvent &evt)=0
 Fill next event from input into evt. More...
 
virtual bool failed ()=0
 
virtual void close ()=0
 
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...
 
void set_run_info (shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object. More...
 

Private Attributes

shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object. More...
 

Constructor & Destructor Documentation

◆ ~Reader() [1/2]

virtual ~Reader ( )
inlinevirtual

Virtual destructor.

Definition at line 29 of file build/outputs/include/HepMC/Reader.h.

◆ ~Reader() [2/2]

virtual ~Reader ( )
inlinevirtual

Virtual destructor.

Definition at line 29 of file include/HepMC/Reader.h.

Member Function Documentation

◆ read_event() [1/2]

virtual bool read_event ( GenEvent evt)
pure virtual

Fill next event from input into evt.

Implemented in ReaderHEPEVT, ReaderHEPEVT, ReaderRootTree, ReaderRoot, ReaderAsciiHepMC2, ReaderAsciiHepMC2, ReaderAscii, and ReaderAscii.

◆ read_event() [2/2]

virtual bool read_event ( GenEvent evt)
pure virtual

Fill next event from input into evt.

Implemented in ReaderHEPEVT, ReaderHEPEVT, ReaderRootTree, ReaderRoot, ReaderAsciiHepMC2, ReaderAsciiHepMC2, ReaderAscii, and ReaderAscii.

◆ run_info() [1/2]

shared_ptr<GenRunInfo> run_info ( ) const
inline

Get the global GenRunInfo object.

Definition at line 37 of file include/HepMC/Reader.h.

References Reader::m_run_info.

◆ run_info() [2/2]

shared_ptr<GenRunInfo> run_info ( ) const
inline

Get the global GenRunInfo object.

Examples:
LHEF_example_cat.cc.

Definition at line 37 of file build/outputs/include/HepMC/Reader.h.

References Reader::m_run_info.

◆ set_run_info() [1/2]

void set_run_info ( shared_ptr< GenRunInfo run)
inlineprotected

Set the global GenRunInfo object.

Definition at line 44 of file include/HepMC/Reader.h.

References Reader::m_run_info.

◆ set_run_info() [2/2]

void set_run_info ( shared_ptr< GenRunInfo run)
inlineprotected

Set the global GenRunInfo object.

Definition at line 44 of file build/outputs/include/HepMC/Reader.h.

References Reader::m_run_info.

Field Documentation

◆ m_run_info

shared_ptr< GenRunInfo > m_run_info
private

The global GenRunInfo object.

Definition at line 51 of file build/outputs/include/HepMC/Reader.h.


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