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

Detailed Description

GenEvent I/O serialization for root files.

If HepMC was compiled with path to ROOT available, this class can be used for root writing in the same manner as with HepMC::WriterAscii class.

Examples
convert_example.cc, and rootIO_example_write.cc.

Definition at line 35 of file WriterRoot.h.

#include <WriterRoot.h>

+ Inheritance diagram for WriterRoot:
+ Collaboration diagram for WriterRoot:

Public Member Functions

 WriterRoot (const std::string &filename, shared_ptr< GenRunInfo > run=shared_ptr< GenRunInfo >())
 Default constructor.
 
void write_event (const GenEvent &evt)
 Write event to file.
 
void write_run_info ()
 Write the GenRunInfo object to file.
 
void close ()
 Close file stream.
 
bool failed ()
 Get stream error state flag.
 
void set_run_info (shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object.
 
shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object.
 

Private Attributes

TFile * m_file
 File handler.
 
int m_events_count
 Events count. Needed to generate unique object name.
 
shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object.
 

Constructor & Destructor Documentation

◆ WriterRoot()

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

Default constructor.

Warning
If file exists, it will be overwritten

Definition at line 19 of file WriterRoot.cc.

References ERROR, WriterRoot::m_file, Writer::run_info(), Writer::set_run_info(), and WriterRoot::write_run_info().

Member Function Documentation

◆ close()

void close ( )
virtual

Close file stream.

Implements Writer.

Examples
rootIO_example_write.cc.

Definition at line 73 of file WriterRoot.cc.

References WriterRoot::m_file.

◆ failed()

bool failed ( )
virtual

Get stream error state flag.

Implements Writer.

Definition at line 77 of file WriterRoot.cc.

References WriterRoot::m_file.

◆ run_info()

shared_ptr< GenRunInfo > run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Definition at line 44 of file Writer.h.

References Writer::m_run_info.

◆ 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 Writer::m_run_info.

◆ write_event()

void write_event ( const GenEvent evt)
virtual

Write event to file.

Parameters
[in]evtEvent to be serialized

Implements Writer.

Examples
rootIO_example_write.cc.

Definition at line 32 of file WriterRoot.cc.

References ERROR, WriterRoot::m_events_count, WriterRoot::m_file, GenEvent::run_info(), Writer::run_info(), Writer::set_run_info(), WARNING, GenEvent::write_data(), and WriterRoot::write_run_info().

◆ write_run_info()

void write_run_info ( )

Write the GenRunInfo object to file.

Definition at line 59 of file WriterRoot.cc.

References ERROR, WriterRoot::m_file, and Writer::run_info().

Field Documentation

◆ m_events_count

int m_events_count
private

Events count. Needed to generate unique object name.

Definition at line 70 of file WriterRoot.h.

◆ m_file

TFile* m_file
private

File handler.

Definition at line 69 of file WriterRoot.h.

◆ m_run_info

shared_ptr<GenRunInfo> m_run_info
privateinherited

The global GenRunInfo object.

Definition at line 51 of file Writer.h.


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