FW::BareAlgorithm Class Reference

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

Inheritance diagram for FW::BareAlgorithm:

Collaboration diagram for FW::BareAlgorithm:

The algorithm name
Constructor The logging level for this algorithm
std::string	m_name
std::unique_ptr< const Acts::Logger >	m_logger
	BareAlgorithm (std::string name, Acts::Logging::Level level=Acts::Logging::INFO)
std::string	name () const finaloverride
	The algorithm name.
virtual ProcessCode	execute (const AlgorithmContext &context) const override=0
const Acts::Logger &	logger () const

Additional Inherited Members
Public Member Functions inherited from FW::IAlgorithm
virtual	~IAlgorithm ()=default

Detailed Description

A helper class for users to implement framework algorithms

This class provides default implementations for most interface methods and and adds a default logger that can be used directly in subclasses. Algorithm implementations only need to implement the execute method.

Definition at line 31 of file BareAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 31 of file BareAlgorithm.hpp

Constructor & Destructor Documentation

FW::BareAlgorithm::BareAlgorithm	(	std::string	name,
		Acts::Logging::Level	level = Acts::Logging::INFO
	)

Definition at line 11 of file BareAlgorithm.cpp.

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

Member Function Documentation

virtual ProcessCode FW::BareAlgorithm::execute ( const AlgorithmContext &  context ) const

overridepure virtual

Execute the algorithm for one event.

This function must be implemented by subclasses.

Implements FW::IAlgorithm.

Implemented in FW::PropagationAlgorithm< propagator_t >, FW::MaterialMapping, FW::TruthVerticesToTracksAlgorithm, FW::GeantinoRecording, FW::FittingAlgorithm, FW::FatrasAlgorithm< simulator_t >, FW::ParticleSelector, FW::ParticleSmearing, FW::DigitizationAlgorithm, FW::HitSmearing, FW::TrackSelector, FWE::VertexFitAlgorithm, FWE::VertexFindingAlgorithm, FW::PrintHits, FW::HelloRandomAlgorithm, FW::TruthTrackFinder, FW::HelloWhiteBoardAlgorithm, FW::FlattenEvent, FW::PrintParticles, and FW::HelloLoggerAlgorithm.

const Acts::Logger& FW::BareAlgorithm::logger ( ) const

inlineprotected

Definition at line 50 of file BareAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 50 of file BareAlgorithm.hpp

References m_logger.

std::string FW::BareAlgorithm::name ( ) const

finaloverridevirtual

The algorithm name.

Implements FW::IAlgorithm.

Definition at line 15 of file BareAlgorithm.cpp.

View newest version in sPHENIX GitHub at line 15 of file BareAlgorithm.cpp

References m_name().

Here is the call graph for this function:

Member Data Documentation

std::unique_ptr<const Acts::Logger> FW::BareAlgorithm::m_logger

private

Definition at line 54 of file BareAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 54 of file BareAlgorithm.hpp

Referenced by logger().

std::string FW::BareAlgorithm::m_name

private

Definition at line 53 of file BareAlgorithm.hpp.

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

---

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

• acts/blob/master/Examples/Framework/include/ACTFW/Framework/BareAlgorithm.hpp
• acts/blob/master/Examples/Framework/src/Framework/BareAlgorithm.cpp