Detailed Description

GenEvent I/O serialization for structured text files.

Examples: convert_example.cc.

Definition at line 26 of file WriterAsciiHepMC2.h.

#include <WriterAsciiHepMC2.h>

Inheritance diagram for WriterAsciiHepMC2:

Collaboration diagram for WriterAsciiHepMC2:

Public Member Functions
	WriterAsciiHepMC2 (const std::string &filename, shared_ptr< GenRunInfo > run=shared_ptr< GenRunInfo >())
	Constructor.
	WriterAsciiHepMC2 (std::ostream &stream, shared_ptr< GenRunInfo > run=shared_ptr< GenRunInfo >())
	Constructor from ostream.
	~WriterAsciiHepMC2 ()
	Destructor.
void	write_event (const GenEvent &evt)
	Write event to file.
void	write_run_info ()
	Write the GenRunInfo object to file.
bool	failed ()
	Return status of the stream.
void	close ()
	Close file stream.
void	set_precision (const int &prec)
	Set output precision.
int	precision () const
	Return output precision.
void	set_run_info (shared_ptr< GenRunInfo > run)
	Set the global GenRunInfo object.
shared_ptr< GenRunInfo >	run_info () const
	Get the global GenRunInfo object.

Private Member Functions
Buffer management
void	allocate_buffer ()
	Attempts to allocate buffer of the chosen size.
void	set_buffer_size (const size_t &size)
	Set buffer size (in bytes).
std::string	escape (const std::string &s) const
	Escape '\' and ' ' characters in string.
void	flush ()
	Inline function flushing buffer to output stream when close to buffer capacity.
void	forced_flush ()
	Inline function forcing flush to the output stream.

Private Attributes
shared_ptr< GenRunInfo >	m_run_info
	The global GenRunInfo object.

Write helpers
std::ofstream	m_file
	Output file.
std::ostream *	m_stream
	Output stream.
int	m_precision
	Output precision.
char *	m_buffer
	Stream buffer.
char *	m_cursor
	Cursor inside stream buffer.
unsigned long	m_buffer_size
	Buffer size.
unsigned long	m_particle_counter
	Used to set bar codes.
void	write_string (const std::string &str)
	Inline function for writing strings.
void	write_vertex (ConstGenVertexPtr v)
	Write vertex.
void	write_particle (ConstGenParticlePtr p, int second_field)
	Write particle.

Constructor & Destructor Documentation

◆ WriterAsciiHepMC2() [1/2]

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

Constructor.

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

Definition at line 23 of file WriterAsciiHepMC2.cc.

References ERROR, m_buffer, m_buffer_size, m_cursor, m_file, m_particle_counter, m_precision, m_stream, Writer::run_info(), Writer::set_run_info(), HepMC3::version(), and WARNING.

◆ WriterAsciiHepMC2() [2/2]

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

Constructor from ostream.

Definition at line 46 of file WriterAsciiHepMC2.cc.

References m_buffer, m_buffer_size, m_cursor, m_file, m_particle_counter, m_precision, m_stream, Writer::run_info(), Writer::set_run_info(), HepMC3::version(), and WARNING.

◆ ~WriterAsciiHepMC2()

~WriterAsciiHepMC2 ( )

Destructor.

Definition at line 63 of file WriterAsciiHepMC2.cc.

References close(), and m_buffer.

Member Function Documentation

◆ allocate_buffer()

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 216 of file WriterAsciiHepMC2.cc.

References ERROR, m_buffer, m_buffer_size, m_cursor, and WARNING.

◆ close()

void close ( )

virtual

Close file stream.

Implements Writer.

Definition at line 399 of file WriterAsciiHepMC2.cc.

References forced_flush(), and m_stream.

◆ escape()

string escape ( const std::string & s ) const

private

Escape '\' and '
' characters in string.

Definition at line 239 of file WriterAsciiHepMC2.cc.

◆ failed()

bool failed ( )

virtual

Return status of the stream.

Implements Writer.

Definition at line 407 of file WriterAsciiHepMC2.cc.

References m_file.

◆ flush()

void flush ( )

inlineprivate

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

Definition at line 305 of file WriterAsciiHepMC2.cc.

References m_buffer, m_buffer_size, m_cursor, and m_stream.

◆ forced_flush()

void forced_flush ( )

inlineprivate

Inline function forcing flush to the output stream.

Definition at line 319 of file WriterAsciiHepMC2.cc.

References m_buffer, m_cursor, and m_stream.

◆ precision()

int precision ( ) const

Return output precision.

Definition at line 414 of file WriterAsciiHepMC2.cc.

References m_precision.

◆ run_info()

shared_ptr< GenRunInfo > run_info ( ) const

inlineinherited

Get the global GenRunInfo object.

Definition at line 44 of file Writer.h.

References m_run_info.

◆ set_buffer_size()

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 418 of file WriterAsciiHepMC2.cc.

References m_buffer, and m_buffer_size.

◆ set_precision()

void set_precision ( const int & prec )

Set output precision.

Available range is [2,24]. Default is 16.

Definition at line 409 of file WriterAsciiHepMC2.cc.

References m_precision.

◆ set_run_info()

void set_run_info ( shared_ptr< GenRunInfo > run )

inlineinherited

Set the global GenRunInfo object.

Definition at line 39 of file Writer.h.

References m_run_info.

◆ write_event()

void write_event ( const GenEvent & evt )

virtual

Write event to file.

Parameters

[in] evt Event to be serialized

Implements Writer.

Definition at line 70 of file WriterAsciiHepMC2.cc.

References allocate_buffer(), GenEvent::attribute(), GenEvent::attributes(), escape(), GenEvent::event_number(), flush(), forced_flush(), GenEvent::length_unit(), m_buffer, m_cursor, m_particle_counter, m_precision, GenEvent::momentum_unit(), Units::name(), GenEvent::run_info(), Writer::run_info(), Writer::set_run_info(), GenEvent::vertices(), WARNING, GenEvent::weights(), write_particle(), write_string(), and write_vertex().

◆ write_particle()

void write_particle	(	ConstGenParticlePtr	p,
		int	second_field )

private

Write particle.

Helper routine for writing single particle to file

Definition at line 329 of file WriterAsciiHepMC2.cc.

References flush(), m_cursor, m_particle_counter, and m_precision.

◆ write_run_info()

void write_run_info ( )

Write the GenRunInfo object to file.

Definition at line 327 of file WriterAsciiHepMC2.cc.

◆ write_string()

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 378 of file WriterAsciiHepMC2.cc.

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

◆ write_vertex()

void write_vertex ( ConstGenVertexPtr v )

private

Write vertex.

Helper routine for writing single vertex to file

Definition at line 260 of file WriterAsciiHepMC2.cc.

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

Field Documentation

◆ m_buffer

char* m_buffer

private

Stream buffer.

Definition at line 121 of file WriterAsciiHepMC2.h.

◆ m_buffer_size

unsigned long m_buffer_size

private

Buffer size.

Definition at line 123 of file WriterAsciiHepMC2.h.

◆ m_cursor

char* m_cursor

private

Cursor inside stream buffer.

Definition at line 122 of file WriterAsciiHepMC2.h.

◆ m_file

std::ofstream m_file

private

Output file.

Definition at line 118 of file WriterAsciiHepMC2.h.

◆ m_particle_counter

unsigned long m_particle_counter

private

Used to set bar codes.

Definition at line 124 of file WriterAsciiHepMC2.h.

◆ m_precision

int m_precision

private

Output precision.

Definition at line 120 of file WriterAsciiHepMC2.h.

◆ m_run_info

shared_ptr<GenRunInfo> m_run_info

privateinherited

The global GenRunInfo object.

Definition at line 51 of file Writer.h.

◆ m_stream

std::ostream* m_stream

private

Output stream.

Definition at line 119 of file WriterAsciiHepMC2.h.

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

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Write helpers

Constructor & Destructor Documentation

◆ WriterAsciiHepMC2() [1/2]

◆ WriterAsciiHepMC2() [2/2]

◆ ~WriterAsciiHepMC2()

Member Function Documentation

◆ allocate_buffer()

◆ close()

◆ escape()

◆ failed()

◆ flush()

◆ forced_flush()

◆ precision()

◆ run_info()

◆ set_buffer_size()

◆ set_precision()

◆ set_run_info()

◆ write_event()

◆ write_particle()

◆ write_run_info()

◆ write_string()

◆ write_vertex()

Field Documentation

◆ m_buffer

◆ m_buffer_size

◆ m_cursor

◆ m_file

◆ m_particle_counter

◆ m_precision

◆ m_run_info

◆ m_stream