HepMC event record
Public Member Functions | Data Fields | Protected Member Functions
ReaderHEPEVT Class Reference

Detailed Description

GenEvent I/O parsing and serialization for HEPEVT files.

Definition at line 24 of file build/outputs/include/HepMC/ReaderHEPEVT.h.

#include <ReaderHEPEVT.h>

+ Inheritance diagram for ReaderHEPEVT:
+ Collaboration diagram for ReaderHEPEVT:

Public Member Functions

 ReaderHEPEVT (const std::string &filename)
 Default constructor. More...
 
virtual bool read_hepevt_event_header ()
 Find and read event header line from file. More...
 
virtual bool read_hepevt_particle (int i, bool iflong=true)
 read particle from file More...
 
bool read_event (GenEvent &evt, bool iflong)
 Read event from file. More...
 
bool read_event (GenEvent &evt)
 Read event from file. More...
 
void close ()
 Close file stream. More...
 
bool failed ()
 Get stream error state. More...
 
 ReaderHEPEVT (const std::string &filename)
 Default constructor. More...
 
virtual bool read_hepevt_event_header ()
 Find and read event header line from file. More...
 
virtual bool read_hepevt_particle (int i, bool iflong=true)
 read particle from file More...
 
bool read_event (GenEvent &evt, bool iflong)
 Read event from file. 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...
 
shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object. More...
 

Data Fields

char * hepevtbuffer
 Pointer to HEPEVT Fortran common block/C struct. More...
 
FILE * m_file
 File to read. More...
 
bool m_failed
 File state. More...
 
int m_events_count
 Event count. 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...
 

Constructor & Destructor Documentation

◆ ReaderHEPEVT() [1/2]

ReaderHEPEVT ( const std::string &  filename)

◆ ReaderHEPEVT() [2/2]

ReaderHEPEVT ( const std::string &  filename)

Default constructor.

Member Function Documentation

◆ close() [1/2]

void close ( )
virtual

Close file stream.

Implements Reader.

Definition at line 128 of file ReaderHEPEVT.cc.

References ReaderHEPEVT::m_file.

◆ close() [2/2]

void close ( )
virtual

Close file stream.

Implements Reader.

◆ failed() [1/2]

bool failed ( )
virtual

Get stream error state.

Implements Reader.

Definition at line 133 of file ReaderHEPEVT.cc.

References ReaderHEPEVT::m_failed.

◆ failed() [2/2]

bool failed ( )
virtual

Get stream error state.

Implements Reader.

◆ read_event() [1/4]

bool read_event ( GenEvent evt,
bool  iflong 
)

Read event from file.

Parameters
[in]iflongEvent style
[out]evtContains parsed even

◆ read_event() [2/4]

bool read_event ( GenEvent evt,
bool  iflong 
)

◆ read_event() [3/4]

bool read_event ( GenEvent evt)
virtual

Read event from file.

Parameters
[out]evtContains parsed even

Implements Reader.

◆ read_event() [4/4]

bool read_event ( GenEvent evt)
virtual

Read event from file.

Parameters
[out]evtContains parsed even

Implements Reader.

Definition at line 124 of file ReaderHEPEVT.cc.

References ReaderHEPEVT::read_event().

◆ read_hepevt_event_header() [1/2]

bool read_hepevt_event_header ( )
virtual

Find and read event header line from file.

Definition at line 31 of file ReaderHEPEVT.cc.

◆ read_hepevt_event_header() [2/2]

virtual bool read_hepevt_event_header ( )
virtual

Find and read event header line from file.

◆ read_hepevt_particle() [1/2]

virtual bool read_hepevt_particle ( int  i,
bool  iflong = true 
)
virtual

read particle from file

Parameters
[in]iParticle id
[in]iflongEvent style

◆ read_hepevt_particle() [2/2]

bool read_hepevt_particle ( int  i,
bool  iflong = true 
)
virtual

read particle from file

Parameters
[in]iParticle id
[in]iflongEvent style

Definition at line 59 of file ReaderHEPEVT.cc.

◆ run_info() [1/2]

shared_ptr<GenRunInfo> run_info ( ) const
inlineinherited

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.

◆ run_info() [2/2]

shared_ptr<GenRunInfo> run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

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

References Reader::m_run_info.

◆ set_run_info() [1/2]

void set_run_info ( shared_ptr< GenRunInfo run)
inlineprotectedinherited

Set the global GenRunInfo object.

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

References Reader::m_run_info.

◆ set_run_info() [2/2]

void set_run_info ( shared_ptr< GenRunInfo run)
inlineprotectedinherited

Set the global GenRunInfo object.

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

References Reader::m_run_info.

Field Documentation

◆ hepevtbuffer

char * hepevtbuffer

Pointer to HEPEVT Fortran common block/C struct.

Definition at line 71 of file build/outputs/include/HepMC/ReaderHEPEVT.h.

◆ m_events_count

int m_events_count

Event count.

Definition at line 74 of file build/outputs/include/HepMC/ReaderHEPEVT.h.

◆ m_failed

bool m_failed

File state.

Definition at line 73 of file build/outputs/include/HepMC/ReaderHEPEVT.h.

◆ m_file

FILE * m_file

File to read.

Definition at line 72 of file build/outputs/include/HepMC/ReaderHEPEVT.h.


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