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

Detailed Description

GenEvent I/O serialization for HEPEVT files.

Definition at line 27 of file WriterHEPEVT.h.

#include <WriterHEPEVT.h>

+ Inheritance diagram for WriterHEPEVT:
+ Collaboration diagram for WriterHEPEVT:

Public Member Functions

 WriterHEPEVT (const std::string &filename)
 Default constructor. More...
 
 WriterHEPEVT (std::ostream &stream)
 Constructor from ostream. More...
 
virtual void write_hepevt_particle (int index, bool iflong=true)
 Write particle to file. More...
 
virtual void write_hepevt_event_header ()
 Write event header to file. More...
 
void write_event (const GenEvent &evt) override
 Write event to file. More...
 
void close () override
 Close file stream. More...
 
bool failed () override
 Get stream error state flag. More...
 
void set_vertices_positions_present (bool iflong)
 set flag if vertex positions are available. Effectively this adds or removes key "vertices_positions_are_absent" to/from the m_options. More...
 
bool get_vertices_positions_present () const
 get flag if vertex positions are available. The flag is deduced from m_options. If the m_options have the key "vertices_positions_are_absent" the result if false. True otherwise. More...
 
void set_run_info (std::shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object. 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 Attributes

std::ofstream m_file
 Output file. More...
 
std::ostream * m_stream
 Output stream. More...
 
char * hepevtbuffer
 Pointer to HEPEVT Fortran common block/C struct. More...
 
int m_events_count
 Events count. Needed to generate unique object name. More...
 
std::map< std::string, std::string > m_options
 options More...
 

Private Attributes

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

Constructor & Destructor Documentation

◆ WriterHEPEVT() [1/2]

WriterHEPEVT ( const std::string &  filename)

Default constructor.

Warning
If file exists, it will be overwritten

Definition at line 20 of file WriterHEPEVT.cc.

References WriterHEPEVT::hepevtbuffer, HEPMC3_WARNING, and HEPEVT_Wrapper::set_hepevt_address().

◆ WriterHEPEVT() [2/2]

WriterHEPEVT ( std::ostream &  stream)

Constructor from ostream.

Definition at line 27 of file WriterHEPEVT.cc.

References WriterHEPEVT::hepevtbuffer, HEPMC3_WARNING, and HEPEVT_Wrapper::set_hepevt_address().

Member Function Documentation

◆ close()

void close ( )
overridevirtual

Close file stream.

Implements Writer.

Definition at line 73 of file WriterHEPEVT.cc.

References WriterHEPEVT::m_stream.

◆ failed()

bool failed ( )
overridevirtual

Get stream error state flag.

Implements Writer.

Definition at line 80 of file WriterHEPEVT.cc.

References WriterHEPEVT::m_file.

◆ get_options()

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

Set options.

Definition at line 61 of file Writer.h.

References Writer::m_options.

◆ get_vertices_positions_present()

bool get_vertices_positions_present ( ) const

get flag if vertex positions are available. The flag is deduced from m_options. If the m_options have the key "vertices_positions_are_absent" the result if false. True otherwise.

Definition at line 87 of file WriterHEPEVT.cc.

References Writer::m_options.

◆ run_info()

std::shared_ptr< GenRunInfo > run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Definition at line 47 of file Writer.h.

References Writer::m_run_info.

◆ set_options()

void set_options ( const std::map< std::string, std::string > &  options)
inlineinherited

Set options.

Definition at line 56 of file Writer.h.

References Writer::m_options.

◆ set_run_info()

void set_run_info ( std::shared_ptr< GenRunInfo run)
inlineinherited

Set the global GenRunInfo object.

Definition at line 42 of file Writer.h.

References Writer::m_run_info.

◆ set_vertices_positions_present()

void set_vertices_positions_present ( bool  iflong)

set flag if vertex positions are available. Effectively this adds or removes key "vertices_positions_are_absent" to/from the m_options.

Definition at line 85 of file WriterHEPEVT.cc.

References Writer::m_options.

◆ write_event()

void write_event ( const GenEvent evt)
overridevirtual

◆ write_hepevt_event_header()

void write_hepevt_event_header ( )
virtual

Write event header to file.

Reimplemented in WriterHEPEVTZEUS.

Definition at line 55 of file WriterHEPEVT.cc.

References HEPEVT_Wrapper::event_number(), WriterHEPEVT::m_stream, and HEPEVT_Wrapper::number_entries().

◆ write_hepevt_particle()

void write_hepevt_particle ( int  index,
bool  iflong = true 
)
virtual

Field Documentation

◆ hepevtbuffer

char* hepevtbuffer
protected

Pointer to HEPEVT Fortran common block/C struct.

Definition at line 81 of file WriterHEPEVT.h.

◆ m_events_count

int m_events_count
protected

Events count. Needed to generate unique object name.

Definition at line 82 of file WriterHEPEVT.h.

◆ m_file

std::ofstream m_file
protected

Output file.

Definition at line 79 of file WriterHEPEVT.h.

◆ m_options

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

options

Definition at line 68 of file Writer.h.

◆ m_run_info

std::shared_ptr<GenRunInfo> m_run_info
privateinherited

The global GenRunInfo object.

Definition at line 73 of file Writer.h.

◆ m_stream

std::ostream* m_stream
protected

Output stream.

Definition at line 80 of file WriterHEPEVT.h.


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