Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::ObjPropagationStepsWriter< step_t > Class Template Reference

#include <acts/blob/sPHENIX/Examples/Io/Obj/include/ActsExamples/Plugins/Obj/ObjPropagationStepsWriter.hpp>

+ Inheritance diagram for ActsExamples::ObjPropagationStepsWriter< step_t >:
+ Collaboration diagram for ActsExamples::ObjPropagationStepsWriter< step_t >:

Classes

struct  Config
 

Public Member Functions

 ObjPropagationStepsWriter (const Config &cfg, Acts::Logging::Level level=Acts::Logging::INFO)
 
 ~ObjPropagationStepsWriter () override=default
 Virtual destructor.
 
ProcessCode finalize () override
 End-of-run hook.
 
const Configconfig () const
 Get readonly access to the config parameters.
 
- Public Member Functions inherited from ActsExamples::WriterT< std::vector< std::vector< step_t > > >
 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
 

Protected Member Functions

ProcessCode writeT (const AlgorithmContext &context, const std::vector< std::vector< step_t >> &stepCollection) override
 !< Internal configuration representation
 
- Protected Member Functions inherited from ActsExamples::WriterT< std::vector< std::vector< step_t > > >
virtual ProcessCode writeT (const AlgorithmContext &context, const std::vector< std::vector< step_t > > &t)=0
 
const Acts::Loggerlogger () const
 

Private Attributes

Config m_cfg
 

Detailed Description

template<typename step_t>
class ActsExamples::ObjPropagationStepsWriter< step_t >

Write out the steps of test propgations for stepping validation Writes one file per event with form:

event000000001-propagation-steps.obj
event000000002-propagation-steps.obj

One Thread per write call and hence thread safe

Definition at line 29 of file ObjPropagationStepsWriter.hpp.

View newest version in sPHENIX GitHub at line 29 of file ObjPropagationStepsWriter.hpp

Constructor & Destructor Documentation

template<typename step_t >
ActsExamples::ObjPropagationStepsWriter< step_t >::ObjPropagationStepsWriter ( const Config cfg,
Acts::Logging::Level  level = Acts::Logging::INFO 
)
inline

Constructor with arguments

Parameters
cfgconfiguration struct
levelOutput logging level

Definition at line 43 of file ObjPropagationStepsWriter.hpp.

View newest version in sPHENIX GitHub at line 43 of file ObjPropagationStepsWriter.hpp

References ActsExamples::ObjPropagationStepsWriter< step_t >::Config::collection, and ActsExamples::ObjPropagationStepsWriter< step_t >::m_cfg.

template<typename step_t >
ActsExamples::ObjPropagationStepsWriter< step_t >::~ObjPropagationStepsWriter ( )
overridedefault

Virtual destructor.

Member Function Documentation

template<typename step_t >
const Config& ActsExamples::ObjPropagationStepsWriter< step_t >::config ( ) const
inline

Get readonly access to the config parameters.

Definition at line 60 of file ObjPropagationStepsWriter.hpp.

View newest version in sPHENIX GitHub at line 60 of file ObjPropagationStepsWriter.hpp

References ActsExamples::ObjPropagationStepsWriter< step_t >::m_cfg.

template<typename step_t >
ProcessCode ActsExamples::ObjPropagationStepsWriter< step_t >::finalize ( )
inlineoverridevirtual

End-of-run hook.

Implements ActsExamples::SequenceElement.

Definition at line 57 of file ObjPropagationStepsWriter.hpp.

View newest version in sPHENIX GitHub at line 57 of file ObjPropagationStepsWriter.hpp

References SUCCESS.

template<typename step_t >
ProcessCode ActsExamples::ObjPropagationStepsWriter< step_t >::writeT ( const AlgorithmContext context,
const std::vector< std::vector< step_t >> &  stepCollection 
)
inlineoverrideprotected

!< Internal configuration representation

This implementation holds the actual writing method and is called by the WriterT<>::write interface

Definition at line 68 of file ObjPropagationStepsWriter.hpp.

View newest version in sPHENIX GitHub at line 68 of file ObjPropagationStepsWriter.hpp

References ActsExamples::AlgorithmContext::eventNumber, ActsExamples::ObjPropagationStepsWriter< step_t >::m_cfg, os, out, ActsExamples::ObjPropagationStepsWriter< step_t >::Config::outputDir, ActsExamples::ObjPropagationStepsWriter< step_t >::Config::outputScalor, path, ActsExamples::perEventFilepath(), step, propagation_timing::steps, and SUCCESS.

+ Here is the call graph for this function:

Member Data Documentation


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