HepMC3 event record library
Public Member Functions | Protected Attributes | Private Attributes
Writer Class Referenceabstract

Detailed Description

Base class for all I/O writers.

Definition at line 25 of file Writer.h.

#include <Writer.h>

+ Inheritance diagram for Writer:
+ Collaboration diagram for Writer:

Public Member Functions

 Writer ()
 Constructor.
 
virtual ~Writer ()
 Virtual destructor.
 
virtual void write_event (const GenEvent &evt)=0
 Write event evt to output target.
 
virtual bool failed ()=0
 Get file and/or stream error state.
 
virtual void close ()=0
 Close file and/or stream.
 
void set_run_info (std::shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object.
 
std::shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object.
 
 Writer (const Writer &)=delete
 deleted copy constructor
 
Writeroperator= (const Writer &)=delete
 deleted copy assignment operator
 
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 Attributes

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

Private Attributes

std::shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object.
 

Constructor & Destructor Documentation

◆ Writer() [1/2]

Writer ( )
inline

Constructor.

Definition at line 29 of file Writer.h.

◆ ~Writer()

virtual ~Writer ( )
inlinevirtual

Virtual destructor.

Definition at line 32 of file Writer.h.

◆ Writer() [2/2]

Writer ( const Writer )
delete

deleted copy constructor

Member Function Documentation

◆ close()

virtual void close ( )
pure virtual

◆ failed()

virtual bool failed ( )
pure virtual

◆ get_options()

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

Set options.

Definition at line 61 of file Writer.h.

References Writer::m_options.

◆ operator=()

Writer & operator= ( const Writer )
delete

deleted copy assignment operator

◆ run_info()

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

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)
inline

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)
inline

Set the global GenRunInfo object.

Definition at line 42 of file Writer.h.

References Writer::m_run_info.

◆ write_event()

virtual void write_event ( const GenEvent evt)
pure virtual

Field Documentation

◆ m_options

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

options

Definition at line 68 of file Writer.h.

◆ m_run_info

std::shared_ptr<GenRunInfo> m_run_info
private

The global GenRunInfo object.

Definition at line 73 of file Writer.h.


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