HepMC3 event record library
WriterHEPEVT.h
Go to the documentation of this file.
1// -*- C++ -*-
2//
3// This file is part of HepMC
4// Copyright (C) 2014-2020 The HepMC collaboration (see AUTHORS for details)
5//
6#ifndef HEPMC3_WRITERHEPEVT_H
7#define HEPMC3_WRITERHEPEVT_H
8/**
9 * @file WriterHEPEVT.h
10 * @brief Definition of \b class WriterHEPEVT
11 *
12 * @class HepMC3::WriterHEPEVT
13 * @brief GenEvent I/O serialization for HEPEVT files
14 *
15 *
16 * @ingroup IO
17 *
18 */
19#include "HepMC3/Writer.h"
20#include "HepMC3/GenEvent.h"
22
23#include <fstream>
24namespace HepMC3
25{
26
27class WriterHEPEVT : public Writer
28{
29//
30// Constructors
31//
32public:
33 /** @brief Default constructor
34 * @warning If file exists, it will be overwritten
35 */
36 WriterHEPEVT(const std::string &filename);
37
38 /// @brief Constructor from ostream
39 WriterHEPEVT(std::ostream& stream);
40//
41// Functions
42//
43public:
44
45 /** @brief Write particle to file
46 *
47 * @param[in] index Particle to be serialized
48 * @param[in] iflong Format of record
49 */
50
51 virtual void write_hepevt_particle( int index, bool iflong=true );
52 /** @brief Write event header to file
53 *
54 */
55 virtual void write_hepevt_event_header();
56
57 /** @brief Write event to file
58 *
59 * @param[in] evt Event to be serialized
60 */
61 void write_event(const GenEvent &evt) override;
62
63 /** @brief Close file stream */
64 void close() override;
65
66 /** @brief Get stream error state flag */
67 bool failed() override;
68 /** @brief set flag if vertex positions are available.
69 * Effectively this adds or removes key "vertices_positions_are_absent"
70 * to/from the m_options.*/
71 void set_vertices_positions_present(bool iflong);
72
73 /** @brief get flag if vertex positions are available.
74 * The flag is deduced from m_options. If the m_options have the key
75 * "vertices_positions_are_absent" the result if false. True otherwise. */
77
78protected:
79 std::ofstream m_file; //!< Output file
80 std::ostream* m_stream; //!< Output stream
81 char* hepevtbuffer; //!< Pointer to HEPEVT Fortran common block/C struct
82 int m_events_count; //!< Events count. Needed to generate unique object name
83};
84
85} // namespace HepMC3
86#endif
Definition of struct GenEventData.
Definition of class GenEvent.
Definition of interface Writer.
Stores event-related information.
Definition: GenEvent.h:41
GenEvent I/O serialization for HEPEVT files.
Definition: WriterHEPEVT.h:28
WriterHEPEVT(const std::string &filename)
Default constructor.
Definition: WriterHEPEVT.cc:20
bool failed() override
Get stream error state flag.
Definition: WriterHEPEVT.cc:80
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...
Definition: WriterHEPEVT.cc:87
void set_vertices_positions_present(bool iflong)
set flag if vertex positions are available. Effectively this adds or removes key "vertices_positions_...
Definition: WriterHEPEVT.cc:85
virtual void write_hepevt_event_header()
Write event header to file.
Definition: WriterHEPEVT.cc:55
int m_events_count
Events count. Needed to generate unique object name.
Definition: WriterHEPEVT.h:82
virtual void write_hepevt_particle(int index, bool iflong=true)
Write particle to file.
Definition: WriterHEPEVT.cc:34
void close() override
Close file stream.
Definition: WriterHEPEVT.cc:73
std::ofstream m_file
Output file.
Definition: WriterHEPEVT.h:79
char * hepevtbuffer
Pointer to HEPEVT Fortran common block/C struct.
Definition: WriterHEPEVT.h:81
void write_event(const GenEvent &evt) override
Write event to file.
Definition: WriterHEPEVT.cc:64
std::ostream * m_stream
Output stream.
Definition: WriterHEPEVT.h:80
Base class for all I/O writers.
Definition: Writer.h:25
HepMC3 main namespace.