Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ActsExamples::WriterT< write_data_t > Class Template Referenceabstract

#include <acts/blob/sPHENIX/Examples/Framework/include/ActsExamples/Framework/WriterT.hpp>

+ Inheritance diagram for ActsExamples::WriterT< write_data_t >:
+ Collaboration diagram for ActsExamples::WriterT< write_data_t >:

Public Member Functions

 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

virtual ProcessCode writeT (const AlgorithmContext &context, const write_data_t &t)=0
 
const Acts::Logger & logger () const
 

Private Attributes

std::string m_objectName
 
std::string m_writerName
 
std::unique_ptr< const
Acts::Logger > 		m_logger
 
ReadDataHandle< write_data_t > m_inputHandle {this, "InputHandle"}
 

Detailed Description

template<typename write_data_t>
class ActsExamples::WriterT< write_data_t >

A helper class for users to implement framework writers.

Note
This is not an additional interface class and should not be used as such, e.g. as a constrained IWriter substitute. This class should only be used as the base class for a concrete writer implementation.
Template Parameters
TThe object type read from the event store

This class can be used when a writer reads a single object from the event store and writes it to file. Reading from the event store and casting to the specified type is done automatically and the user only needs to implement the type-specific write method.

Default no-op implementations for initialize and finalize are provided but can be overridden by the user.

Definition at line 47 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 47 of file WriterT.hpp

Constructor & Destructor Documentation

template<typename write_data_t >
ActsExamples::WriterT< write_data_t >::WriterT ( std::string  objectName,
std::string  writerName,
Acts::Logging::Level  level 
)
Parameters
objectNameThe object that should be read from the event store
writerNameThe name of the writer, e.g. for logging output
levelThe internal log level

Definition at line 86 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 86 of file WriterT.hpp

References ActsExamples::ReadDataHandle< T >::initialize(), ActsExamples::WriterT< write_data_t >::m_inputHandle, ActsExamples::WriterT< write_data_t >::m_objectName, and ActsExamples::WriterT< write_data_t >::m_writerName.

+ Here is the call graph for this function:

Member Function Documentation

template<typename write_data_t >
ActsExamples::ProcessCode ActsExamples::WriterT< write_data_t >::finalize ( )
inlineoverridevirtual

No-op default implementation.

Implements ActsExamples::SequenceElement.

Reimplemented in ActsExamples::RootTrackParameterWriter.

Definition at line 108 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 108 of file WriterT.hpp

References SUCCESS.

template<typename write_data_t>
const Acts::Logger& ActsExamples::WriterT< write_data_t >::logger ( ) const
inlineprotected

Definition at line 73 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 73 of file WriterT.hpp

template<typename write_data_t >
std::string ActsExamples::WriterT< write_data_t >::name ( ) const
inlineoverridevirtual

Provide the name of the writer.

Implements ActsExamples::SequenceElement.

Definition at line 102 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 102 of file WriterT.hpp

template<typename write_data_t >
ActsExamples::ProcessCode ActsExamples::WriterT< write_data_t >::write ( const AlgorithmContext &  context)
inlineoverridevirtual

Read the object and call the type-specific member function.

Implements ActsExamples::IWriter.

Definition at line 113 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 113 of file WriterT.hpp

template<typename write_data_t>
virtual ProcessCode ActsExamples::WriterT< write_data_t >::writeT ( const AlgorithmContext &  context,
const write_data_t &  t 
)
protectedpure virtual

Type-specific write function implementation this method is implemented in the user implementation

Parameters
[in]contextis the algorithm context that guarantees event consistency
Template Parameters
[in]is the templated collection to be written

Implemented in ActsExamples::RootMeasurementWriter, ActsExamples::SvgPointWriter< T, Acc >, ActsExamples::RootMaterialTrackWriter, ActsExamples::RootTrajectoryStatesWriter, ActsExamples::RootTrajectorySummaryWriter, ActsExamples::CKFPerformanceWriter, ActsExamples::RootPlanarClusterWriter, ActsExamples::CsvMeasurementWriter, ActsExamples::CsvPlanarClusterWriter, ActsExamples::CsvMultiTrajectoryWriter, ActsExamples::TrackFitterPerformanceWriter, ActsExamples::RootNuclearInteractionParametersWriter, ActsExamples::RootPropagationStepsWriter, ActsExamples::CsvSpacepointWriter, ActsExamples::SeedingPerformanceWriter, ActsExamples::RootParticleWriter, ActsExamples::RootSpacepointWriter, ActsExamples::RootSimHitWriter, ActsExamples::CsvParticleWriter, ActsExamples::EDM4hepMultiTrajectoryWriter, ActsExamples::CsvSimHitWriter, ActsExamples::EDM4hepSimHitWriter, ActsExamples::CsvProtoTrackWriter, ActsExamples::EDM4hepMeasurementWriter, ActsExamples::TrackFinderPerformanceWriter, ActsExamples::EDM4hepTrackWriter, ActsExamples::EDM4hepParticleWriter, ActsExamples::JsonSpacePointWriter< T >, ActsExamples::HepMC3AsciiWriter, and ActsExamples::ObjSpacePointWriter< T >.

Member Data Documentation

template<typename write_data_t>
ReadDataHandle<write_data_t> ActsExamples::WriterT< write_data_t >::m_inputHandle {this, "InputHandle"}
private

Definition at line 80 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 80 of file WriterT.hpp

Referenced by ActsExamples::WriterT< write_data_t >::WriterT().

template<typename write_data_t>
std::unique_ptr<const Acts::Logger> ActsExamples::WriterT< write_data_t >::m_logger
private

Definition at line 78 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 78 of file WriterT.hpp

Referenced by ActsExamples::WriterT< MeasurementContainer >::logger().

template<typename write_data_t>
std::string ActsExamples::WriterT< write_data_t >::m_objectName
private

Definition at line 76 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 76 of file WriterT.hpp

Referenced by ActsExamples::WriterT< write_data_t >::WriterT().

template<typename write_data_t>
std::string ActsExamples::WriterT< write_data_t >::m_writerName
private

Definition at line 77 of file WriterT.hpp.

View newest version in sPHENIX GitHub at line 77 of file WriterT.hpp

Referenced by ActsExamples::WriterT< write_data_t >::WriterT().

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