Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::HepMC3AsciiWriter Exception Referencefinal

HepMC3 event writer. More...

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

+ Inheritance diagram for ActsExamples::HepMC3AsciiWriter:
+ Collaboration diagram for ActsExamples::HepMC3AsciiWriter:

Classes

struct  Config
 

Public Member Functions

 HepMC3AsciiWriter (const Config &config, Acts::Logging::Level level)
 
ProcessCode writeT (const ActsExamples::AlgorithmContext &ctx, const std::vector< HepMC3::GenEvent > &events) override
 
const Configconfig () const
 Get readonly access to the config parameters.
 
- Public Member Functions inherited from ActsExamples::WriterT< std::vector< HepMC3::GenEvent > >
 WriterT (std::string objectName, std::string writerName, Acts::Logging::Level level)
 
std::string name () const override
 Provide the name of the writer.
 
ProcessCode write (const AlgorithmContext &context) override
 Read the object and call the type-specific member function.
 
ProcessCode finalize () override
 No-op default implementation.
 
- Public Member Functions inherited from ActsExamples::IWriter
ProcessCode internalExecute (const AlgorithmContext &context) final
 
ProcessCode initialize () override
 Fulfil the algorithm interface.
 
- Public Member Functions inherited from ActsExamples::SequenceElement
virtual ~SequenceElement ()=default
 
const std::vector< const
DataHandleBase * > & 
writeHandles () const
 
const std::vector< const
DataHandleBase * > & 
readHandles () const
 

Private Attributes

Config m_cfg
 The configuration of this writer.
 

Additional Inherited Members

- Protected Member Functions inherited from ActsExamples::WriterT< std::vector< HepMC3::GenEvent > >
const Acts::Loggerlogger () const
 

Detailed Description

HepMC3 event writer.

Definition at line 22 of file HepMC3Writer.hpp.

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

Constructor & Destructor Documentation

ActsExamples::HepMC3AsciiWriter::HepMC3AsciiWriter ( const Config config,
Acts::Logging::Level  level 
)

Construct the writer.

Parameters
[in]configConfig of the writer
[in]levelThe level of the logger

Definition at line 13 of file HepMC3Writer.cpp.

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

References m_cfg, and ActsExamples::HepMC3AsciiWriter::Config::outputStem.

Member Function Documentation

const Config& ActsExamples::HepMC3AsciiWriter::config ( ) const
inline

Get readonly access to the config parameters.

Definition at line 49 of file HepMC3Writer.hpp.

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

References m_cfg.

ActsExamples::ProcessCode ActsExamples::HepMC3AsciiWriter::writeT ( const ActsExamples::AlgorithmContext ctx,
const std::vector< HepMC3::GenEvent > &  events 
)
overridevirtual

Writing events to file.

Parameters
[in]ctxThe context of this algorithm
[in]eventsThe recorded HepMC3 events
Returns
Code describing whether the writing was successful

Implements ActsExamples::WriterT< std::vector< HepMC3::GenEvent > >.

Definition at line 21 of file HepMC3Writer.cpp.

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

References ACTS_DEBUG, event, ActsExamples::AlgorithmContext::eventNumber, m_cfg(), path, ActsExamples::perEventFilepath(), SUCCESS, and writer.

+ Here is the call graph for this function:

Member Data Documentation

Config ActsExamples::HepMC3AsciiWriter::m_cfg
private

The configuration of this writer.

Definition at line 53 of file HepMC3Writer.hpp.

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

Referenced by config(), and HepMC3AsciiWriter().


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