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

GenEvent I/O serialization for structured text files. More...

#include <WriterAscii.h>

+ Inheritance diagram for WriterAscii:
+ Collaboration diagram for WriterAscii:

Public Member Functions

 WriterAscii (const std::string &filename, std::shared_ptr< GenRunInfo > run=std::shared_ptr< GenRunInfo >())
 Constructor. More...
 
 WriterAscii (std::ostream &stream, std::shared_ptr< GenRunInfo > run=std::shared_ptr< GenRunInfo >())
 Constructor from ostream. More...
 
 ~WriterAscii ()
 Destructor. More...
 
void write_event (const GenEvent &evt) override
 Write event to file. More...
 
void write_run_info ()
 Write the GenRunInfo object to file. More...
 
bool failed () override
 Return status of the stream. More...
 
void close () override
 Close file stream. More...
 
void set_precision (const int &prec)
 Set output precision. More...
 
int precision () const
 Return output precision. 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::map< std::string,
std::string > 
m_options
 options More...
 

Private Member Functions

Buffer management
void allocate_buffer ()
 Attempts to allocate buffer of the chosen size. More...
 
void set_buffer_size (const size_t &size)
 Set buffer size (in bytes) More...
 
std::string escape (const std::string &s) const
 Escape '\' and '
' characters in string. More...
 
void flush ()
 Inline function flushing buffer to output stream when close to buffer capacity. More...
 
void forced_flush ()
 Inline function forcing flush to the output stream. More...
 
Write helpers
void write_string (const std::string &str)
 Inline function for writing strings. More...
 
void write_vertex (ConstGenVertexPtr v)
 Write vertex. More...
 
void write_particle (ConstGenParticlePtr p, int second_field)
 Write particle. More...
 

Private Attributes

std::ofstream m_file
 Output file. More...
 
std::ostream * m_stream
 Output stream. More...
 
int m_precision
 Output precision. More...
 
char * m_buffer
 Stream buffer. More...
 
char * m_cursor
 Cursor inside stream buffer. More...
 
unsigned long m_buffer_size
 Buffer size. More...
 

Detailed Description

GenEvent I/O serialization for structured text files.

Examples:
class_example_read.cc, HepMC2_reader_example.cc, HepMC3_fileIO_example.cc, LHEF_example_cat.cc, pythia8_example.cc, and rootIO_example_read.cc.

Definition at line 25 of file WriterAscii.h.

Constructor & Destructor Documentation

WriterAscii ( const std::string &  filename,
std::shared_ptr< GenRunInfo run = std::shared_ptr<GenRunInfo>() 
)

Constructor.

Warning
If file already exists, it will be cleared before writing

Definition at line 22 of file WriterAscii.cc.

References HEPMC3_ERROR, WriterAscii::m_file, Writer::run_info(), Writer::set_run_info(), HepMC3::version(), and WriterAscii::write_run_info().

WriterAscii ( std::ostream &  stream,
std::shared_ptr< GenRunInfo run = std::shared_ptr<GenRunInfo>() 
)

Constructor from ostream.

Definition at line 41 of file WriterAscii.cc.

References Writer::run_info(), Writer::set_run_info(), HepMC3::version(), and WriterAscii::write_run_info().

Destructor.

Definition at line 57 of file WriterAscii.cc.

References WriterAscii::close(), and WriterAscii::m_buffer.

Member Function Documentation

void allocate_buffer ( )
private

Attempts to allocate buffer of the chosen size.

This function can be called manually by the user or will be called before first read/write operation

Note
If buffer size is too large it will be divided by 2 until it is small enough for system to allocate

Definition at line 170 of file WriterAscii.cc.

References HEPMC3_ERROR, HEPMC3_WARNING, WriterAscii::m_buffer, WriterAscii::m_buffer_size, and WriterAscii::m_cursor.

void close ( )
overridevirtual
std::string escape ( const std::string &  s) const
private

Escape '\' and '
' characters in string.

Definition at line 190 of file WriterAscii.cc.

bool failed ( )
overridevirtual

Return status of the stream.

Implements Writer.

Definition at line 361 of file WriterAscii.cc.

References WriterAscii::m_file.

void flush ( )
inlineprivate

Inline function flushing buffer to output stream when close to buffer capacity.

Definition at line 247 of file WriterAscii.cc.

References WriterAscii::m_buffer, WriterAscii::m_buffer_size, WriterAscii::m_cursor, and WriterAscii::m_stream.

void forced_flush ( )
inlineprivate

Inline function forcing flush to the output stream.

Definition at line 260 of file WriterAscii.cc.

References WriterAscii::m_buffer, WriterAscii::m_cursor, and WriterAscii::m_stream.

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

Set options.

Definition at line 61 of file Writer.h.

References Writer::m_options.

int precision ( ) const

Return output precision.

Definition at line 368 of file WriterAscii.cc.

References WriterAscii::m_precision.

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.

void set_buffer_size ( const size_t &  size)
private

Set buffer size (in bytes)

Default is 256kb. Minimum is 256b. Size can only be changed before first read/write operation.

Definition at line 372 of file WriterAscii.cc.

References WriterAscii::m_buffer, and WriterAscii::m_buffer_size.

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.

void set_precision ( const int &  prec)

Set output precision.

So far available range is [2,24]. Default is 16.

Definition at line 363 of file WriterAscii.cc.

References WriterAscii::m_precision.

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.

void write_event ( const GenEvent evt)
overridevirtual
void write_particle ( ConstGenParticlePtr  p,
int  second_field 
)
private

Write particle.

Helper routine for writing single particle to file

Definition at line 311 of file WriterAscii.cc.

References WriterAscii::flush(), WriterAscii::m_cursor, and WriterAscii::m_precision.

void write_run_info ( )
void write_string ( const std::string &  str)
inlineprivate

Inline function for writing strings.

Since strings can be long (maybe even longer than buffer) they have to be dealt with separately.

Definition at line 335 of file WriterAscii.cc.

References WriterAscii::flush(), WriterAscii::forced_flush(), WriterAscii::m_buffer, WriterAscii::m_buffer_size, WriterAscii::m_cursor, and WriterAscii::m_stream.

void write_vertex ( ConstGenVertexPtr  v)
private

Write vertex.

Helper routine for writing single vertex to file

Definition at line 208 of file WriterAscii.cc.

References WriterAscii::flush(), FourVector::is_zero(), WriterAscii::m_cursor, WriterAscii::m_precision, FourVector::t(), FourVector::x(), FourVector::y(), and FourVector::z().

Field Documentation

char* m_buffer
private

Stream buffer.

Definition at line 119 of file WriterAscii.h.

unsigned long m_buffer_size
private

Buffer size.

Definition at line 121 of file WriterAscii.h.

char* m_cursor
private

Cursor inside stream buffer.

Definition at line 120 of file WriterAscii.h.

std::ofstream m_file
private

Output file.

Definition at line 115 of file WriterAscii.h.

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

options

Definition at line 68 of file Writer.h.

int m_precision
private

Output precision.

Definition at line 118 of file WriterAscii.h.

std::ostream* m_stream
private

Output stream.

Definition at line 116 of file WriterAscii.h.


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