EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::HepMC3WriterAscii Struct Reference

HepMC3 event writer. More...

#include <acts/blob/sPHENIX/Examples/Io/HepMC3/include/ActsExamples/Plugins/HepMC3/HepMC3Writer.hpp>

Public Member Functions

bool writeEvent (HepMC3::WriterAscii &writer, std::shared_ptr< HepMC3::GenEvent > event)
 Writes an event to file.
 
bool status (HepMC3::WriterAscii &writer)
 Reports the status of the writer.
 

Detailed Description

HepMC3 event writer.

Definition at line 17 of file HepMC3Writer.hpp.

View newest version in sPHENIX GitHub at line 17 of file HepMC3Writer.hpp

Member Function Documentation

bool ActsExamples::HepMC3WriterAscii::status ( HepMC3::WriterAscii &  writer)

Reports the status of the writer.

Parameters
writerwriter of run files
Returns
boolean status indicator

Definition at line 18 of file HepMC3Writer.cpp.

View newest version in sPHENIX GitHub at line 18 of file HepMC3Writer.cpp

bool ActsExamples::HepMC3WriterAscii::writeEvent ( HepMC3::WriterAscii &  writer,
std::shared_ptr< HepMC3::GenEvent >  event 
)

Writes an event to file.

Parameters
writerwriter of run files
eventstorage of the event
Returns
boolean indicator if the writing was successful
Note
HepMC3 does not state a success or failure. The returned argument is always true.

Definition at line 11 of file HepMC3Writer.cpp.

View newest version in sPHENIX GitHub at line 11 of file HepMC3Writer.cpp


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