FW::WriterT< write_data_t > Class Template Reference

#include <acts/blob/master/Examples/Framework/include/ACTFW/Framework/WriterT.hpp>

Inheritance diagram for FW::WriterT< write_data_t >:

Collaboration diagram for FW::WriterT< write_data_t >:

Public Member Functions
	WriterT (std::string objectName, std::string writerName, Acts::Logging::Level level)
std::string	name () const finaloverride
	Provide the name of the writer.
ProcessCode	write (const AlgorithmContext &context) finaloverride
	Read the object and call the type-specific member function.
ProcessCode	endRun () override
	No-op default implementation.
Public Member Functions inherited from FW::IWriter
virtual	~IWriter ()=default

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

Detailed Description

template<typename write_data_t>
class FW::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

T	The 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 overriden by the user.

Definition at line 40 of file WriterT.hpp.

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

Constructor & Destructor Documentation

template<typename write_data_t >

FW::WriterT< write_data_t >::WriterT	(	std::string	objectName,
		std::string	writerName,
		Acts::Logging::Level	level
	)

Parameters

objectName	The object that should be read from the event store
writerName	The name of the writer, e.g. for logging output
level	The internal log level

Definition at line 77 of file WriterT.hpp.

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

References FW::WriterT< write_data_t >::m_objectName, and FW::WriterT< write_data_t >::m_writerName.

Member Function Documentation

template<typename write_data_t >

FW::ProcessCode FW::WriterT< write_data_t >::endRun ( )

inlineoverridevirtual

No-op default implementation.

Implements FW::IWriter.

Reimplemented in FW::RootTrackParameterWriter.

Definition at line 96 of file WriterT.hpp.

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

References SUCCESS.

template<typename write_data_t>

const Acts::Logger& FW::WriterT< write_data_t >::logger ( ) const

inlineprotected

Definition at line 66 of file WriterT.hpp.

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

template<typename write_data_t >

std::string FW::WriterT< write_data_t >::name ( ) const

inlinefinaloverridevirtual

Provide the name of the writer.

Implements FW::IWriter.

Definition at line 91 of file WriterT.hpp.

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

template<typename write_data_t >

FW::ProcessCode FW::WriterT< write_data_t >::write ( const AlgorithmContext &  context )

inlinefinaloverridevirtual

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

Implements FW::IWriter.

Definition at line 101 of file WriterT.hpp.

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

References FW::AlgorithmContext::eventStore, and FW::WhiteBoard::get().

Here is the call graph for this function:

template<typename write_data_t>

virtual ProcessCode FW::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]

context

is the algorithm context that guarantees event consistency

Template Parameters

[in]	is the templeted collection to be written

Implemented in FW::RootMaterialTrackWriter, FW::RootTrajectoryWriter, FW::RootPlanarClusterWriter, FW::RootPropagationStepsWriter, FW::CsvPlanarClusterWriter, FW::RootParticleWriter, FW::RootSimHitWriter, FW::CsvParticleWriter, FW::RootVertexAndTracksWriter, FW::TrackFitterPerformanceWriter, FW::Json::JsonSpacePointWriter< T >, FW::Obj::ObjSpacePointWriter< T >, and FW::TrackFinderPerformanceWriter.

Member Data Documentation

template<typename write_data_t>

std::unique_ptr<const Acts::Logger> FW::WriterT< write_data_t >::m_logger

private

Definition at line 71 of file WriterT.hpp.

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

Referenced by FW::WriterT< TrajectoryContainer >::logger().

template<typename write_data_t>

std::string FW::WriterT< write_data_t >::m_objectName

private

Definition at line 69 of file WriterT.hpp.

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

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

template<typename write_data_t>

std::string FW::WriterT< write_data_t >::m_writerName

private

Definition at line 70 of file WriterT.hpp.

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

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

---

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

• acts/blob/master/Examples/Framework/include/ACTFW/Framework/WriterT.hpp