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

Detailed Description

GenEvent I/O parsing for structured text files.

Examples
HepMC3_fileIO_example.cc, LHEF_example_cat.cc, class_example_write.cc, and rootIO_example_write.cc.

Definition at line 29 of file ReaderAscii.h.

#include <ReaderAscii.h>

+ Inheritance diagram for ReaderAscii:
+ Collaboration diagram for ReaderAscii:

Public Member Functions

 ReaderAscii (const std::string &filename)
 Constructor.
 
 ReaderAscii (std::istream &)
 The ctor to read from stream.
 
 ReaderAscii (std::shared_ptr< std::istream > s_stream)
 The ctor to read from stream. Useful for temp. streams.
 
 ~ReaderAscii ()
 Destructor.
 
bool skip (const int) override
 skip events
 
bool read_event (GenEvent &evt) override
 Load event from file.
 
bool failed () override
 Return status of the stream.
 
void close () override
 Close file stream.
 
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.
 

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

std::string unescape (const std::string &s)
 Unsecape '\' and '
' characters in string.
 
Read helpers
std::pair< int, int > parse_event_information (GenEvent &evt, const char *buf)
 Parse event.
 
bool parse_weight_values (GenEvent &evt, const char *buf)
 Parse weight value lines.
 
bool parse_units (GenEvent &evt, const char *buf)
 Parse units.
 
bool parse_pdf_info (GenEvent &evt, const char *buf)
 Parse struct GenPdfInfo information.
 
bool parse_heavy_ion (GenEvent &evt, const char *buf)
 Parse struct GenHeavyIon information.
 
bool parse_cross_section (GenEvent &evt, const char *buf)
 Parse struct GenCrossSection information.
 
bool parse_vertex_information (GenEvent &evt, const char *buf)
 Parse vertex.
 
bool parse_particle_information (GenEvent &evt, const char *buf)
 Parse particle.
 
bool parse_attribute (GenEvent &evt, const char *buf)
 Parse attribute.
 
bool parse_run_attribute (const char *buf)
 Parse run-level attribute.
 
bool parse_weight_names (const char *buf)
 Parse run-level weight names.
 
bool parse_tool (const char *buf)
 Parse run-level tool information.
 

Private Attributes

std::ifstream m_file
 Input file.
 
std::shared_ptr< std::istream > m_shared_stream
 For ctor when reading from temp. stream.
 
std::istream * m_stream
 For ctor when reading from stream.
 
bool m_isstream
 toggles usage of m_file or m_stream
 
std::map< std::string, std::shared_ptr< Attribute > > m_global_attributes
 Store attributes global to the run being written/read.
 
std::map< GenVertexPtr, std::set< int > > m_forward_mothers
 Temp storage for outgoing particle ids.
 
std::map< GenParticlePtr, int > m_forward_daughters
 Temp storage for prod vertex ids.
 
std::shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object.
 

Constructor & Destructor Documentation

◆ ReaderAscii() [1/3]

ReaderAscii ( const std::string &  filename)

Constructor.

Definition at line 23 of file ReaderAscii.cc.

References HEPMC3_ERROR, ReaderAscii::m_file, and Reader::set_run_info().

◆ ReaderAscii() [2/3]

ReaderAscii ( std::istream &  stream)

The ctor to read from stream.

Definition at line 32 of file ReaderAscii.cc.

References HEPMC3_ERROR, ReaderAscii::m_stream, and Reader::set_run_info().

◆ ReaderAscii() [3/3]

ReaderAscii ( std::shared_ptr< std::istream >  s_stream)

The ctor to read from stream. Useful for temp. streams.

Definition at line 42 of file ReaderAscii.cc.

References HEPMC3_ERROR, ReaderAscii::m_stream, and Reader::set_run_info().

◆ ~ReaderAscii()

Destructor.

Definition at line 51 of file ReaderAscii.cc.

References ReaderAscii::close(), and ReaderAscii::m_isstream.

Member Function Documentation

◆ close()

void close ( )
overridevirtual

Close file stream.

Todo:
Implicit cast to bool = !failed()?

Implements Reader.

Examples
HepMC3_fileIO_example.cc, class_example_write.cc, and rootIO_example_write.cc.

Definition at line 617 of file ReaderAscii.cc.

References ReaderAscii::m_file.

◆ failed()

bool failed ( )
overridevirtual

Return status of the stream.

Todo:
No-arg version returning GenEvent?

Implements Reader.

Examples
HepMC3_fileIO_example.cc, class_example_write.cc, and rootIO_example_write.cc.

Definition at line 615 of file ReaderAscii.cc.

References ReaderAscii::m_file, ReaderAscii::m_isstream, and ReaderAscii::m_stream.

◆ 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.

◆ parse_attribute()

bool parse_attribute ( GenEvent evt,
const char *  buf 
)
private

Parse attribute.

Helper routine for parsing single attribute information

Parameters
[out]evtEvent that will contain parsed attribute
[in]bufLine of text that needs to be parsed

Definition at line 516 of file ReaderAscii.cc.

References GenEvent::add_attribute(), and ReaderAscii::unescape().

◆ parse_cross_section()

bool parse_cross_section ( GenEvent evt,
const char *  buf 
)
private

Parse struct GenCrossSection information.

Helper routine for parsing cross-section information

Parameters
[out]evtEvent that will be filled with unit information
[in]bufLine of text that needs to be parsed

◆ parse_event_information()

std::pair< int, int > parse_event_information ( GenEvent evt,
const char *  buf 
)
private

Parse event.

Helper routine for parsing event information

Parameters
[out]evtEvent that will be filled with new data
[in]bufLine of text that needs to be parsed
Returns
vertices count and particles count for verification

Definition at line 274 of file ReaderAscii.cc.

References HEPMC3_DEBUG, GenEvent::set_event_number(), FourVector::setT(), FourVector::setX(), FourVector::setY(), FourVector::setZ(), and GenEvent::shift_position_to().

◆ parse_heavy_ion()

bool parse_heavy_ion ( GenEvent evt,
const char *  buf 
)
private

Parse struct GenHeavyIon information.

Helper routine for parsing heavy ion information

Parameters
[out]evtEvent that will be filled with unit information
[in]bufLine of text that needs to be parsed

◆ parse_particle_information()

bool parse_particle_information ( GenEvent evt,
const char *  buf 
)
private

Parse particle.

Helper routine for parsing single particle information

Parameters
[out]evtEvent that will contain parsed particle
[in]bufLine of text that needs to be parsed
Todo:
Should be an exception

Definition at line 429 of file ReaderAscii.cc.

References GenEvent::add_particle(), GenEvent::add_vertex(), HEPMC3_DEBUG, HEPMC3_ERROR, ReaderAscii::m_forward_daughters, GenEvent::particles(), FourVector::setE(), FourVector::setPx(), FourVector::setPy(), FourVector::setPz(), and GenEvent::vertices().

◆ parse_pdf_info()

bool parse_pdf_info ( GenEvent evt,
const char *  buf 
)
private

Parse struct GenPdfInfo information.

Helper routine for parsing PDF information

Parameters
[out]evtEvent that will be filled with unit information
[in]bufLine of text that needs to be parsed

◆ parse_run_attribute()

bool parse_run_attribute ( const char *  buf)
private

Parse run-level attribute.

Helper routine for parsing single attribute information

Parameters
[in]bufLine of text that needs to be parsed

Definition at line 541 of file ReaderAscii.cc.

References Reader::run_info(), and ReaderAscii::unescape().

◆ parse_tool()

bool parse_tool ( const char *  buf)
private

Parse run-level tool information.

Helper routine for parsing a line with information about tools being used.

Parameters
[in]bufLine of text that needs to be parsed

Definition at line 579 of file ReaderAscii.cc.

References GenRunInfo::ToolInfo::description, GenRunInfo::ToolInfo::name, Reader::run_info(), ReaderAscii::unescape(), and GenRunInfo::ToolInfo::version.

◆ parse_units()

bool parse_units ( GenEvent evt,
const char *  buf 
)
private

Parse units.

Helper routine for parsing units information

Parameters
[out]evtEvent that will be filled with unit information
[in]bufLine of text that needs to be parsed

Definition at line 336 of file ReaderAscii.cc.

References HEPMC3_DEBUG, GenEvent::length_unit(), Units::length_unit(), GenEvent::momentum_unit(), Units::momentum_unit(), Units::name(), and GenEvent::set_units().

◆ parse_vertex_information()

bool parse_vertex_information ( GenEvent evt,
const char *  buf 
)
private

Parse vertex.

Helper routine for parsing single event information

Parameters
[out]evtEvent that will contain parsed vertex
[in]bufLine of text that needs to be parsed

Definition at line 357 of file ReaderAscii.cc.

References GenEvent::add_vertex(), HEPMC3_DEBUG, ReaderAscii::m_forward_mothers, GenEvent::particles(), FourVector::setT(), FourVector::setX(), FourVector::setY(), and FourVector::setZ().

◆ parse_weight_names()

bool parse_weight_names ( const char *  buf)
private

Parse run-level weight names.

Helper routine for parsing a line with information about weight names.

Parameters
[in]bufLine of text that needs to be parsed

Definition at line 563 of file ReaderAscii.cc.

References Reader::run_info(), and ReaderAscii::unescape().

◆ parse_weight_values()

bool parse_weight_values ( GenEvent evt,
const char *  buf 
)
private

Parse weight value lines.

Helper routine for parsing weight value information

Parameters
[out]evtEvent whose GenWeights will be filled with weight values
[in]bufLine of text that needs to be parsed

Definition at line 320 of file ReaderAscii.cc.

References Reader::run_info(), and GenEvent::weights().

◆ 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

◆ unescape()

std::string unescape ( const std::string &  s)
private

Unsecape '\' and '
' characters in string.

Definition at line 598 of file ReaderAscii.cc.

Field Documentation

◆ m_file

std::ifstream m_file
private

Input file.

Definition at line 158 of file ReaderAscii.h.

◆ m_forward_daughters

std::map<GenParticlePtr, int > m_forward_daughters
private

Temp storage for prod vertex ids.

Definition at line 170 of file ReaderAscii.h.

◆ m_forward_mothers

std::map<GenVertexPtr, std::set<int> > m_forward_mothers
private

Temp storage for outgoing particle ids.

Definition at line 168 of file ReaderAscii.h.

◆ m_global_attributes

std::map< std::string, std::shared_ptr<Attribute> > m_global_attributes
private

Store attributes global to the run being written/read.

Definition at line 165 of file ReaderAscii.h.

◆ m_isstream

bool m_isstream
private

toggles usage of m_file or m_stream

Definition at line 161 of file ReaderAscii.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_shared_stream

std::shared_ptr<std::istream> m_shared_stream
private

For ctor when reading from temp. stream.

Definition at line 159 of file ReaderAscii.h.

◆ m_stream

std::istream* m_stream
private

For ctor when reading from stream.

Definition at line 160 of file ReaderAscii.h.


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