FW::BField::BFieldScalor Class Reference

#include <acts/blob/master/Examples/Detectors/MagneticField/include/ACTFW/Plugins/BField/BFieldScalor.hpp>

Inheritance diagram for FW::BField::BFieldScalor:

Collaboration diagram for FW::BField::BFieldScalor:

Classes
struct	Config
	nested configuration struct More...

Public Member Functions
	BFieldScalor (const Config &cfg, std::unique_ptr< const Acts::Logger > logger=Acts::getDefaultLogger("BFieldScalor", Acts::Logging::INFO))
virtual	~BFieldScalor ()=default
	Virtual destructor.
ProcessCode	decorate (AlgorithmContext &context) finaloverride
	decorates (adds, modifies) the AlgorithmContext with a geometric rotation per event
const std::string &	name () const finaloverride
	decorator name() for screen output
Public Member Functions inherited from FW::IContextDecorator
virtual	~IContextDecorator ()=default
	Virtual destructor.

Private Member Functions
const Acts::Logger &	logger () const
	Private access to the logging instance.

Private Attributes
Config	m_cfg
	the configuration class
std::unique_ptr< const Acts::Logger >	m_logger
std::string	m_name = "BFieldScalor"
	!< the logging instance

Detailed Description

A mockup service that rotates a cylindrical geometry

Definition at line 25 of file BFieldScalor.hpp.

View newest version in sPHENIX GitHub at line 25 of file BFieldScalor.hpp

Constructor & Destructor Documentation

FW::BField::BFieldScalor::BFieldScalor	(	const Config &	cfg,
		std::unique_ptr< const Acts::Logger >	logger = Acts::getDefaultLogger("BFieldScalor", Acts::Logging::INFO)
	)

Constructor

Parameters

cfg	Configuration struct
logger	The logging framework

Definition at line 15 of file BFieldScalor.cpp.

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

virtual FW::BField::BFieldScalor::~BFieldScalor ( )

virtualdefault

Virtual destructor.

Member Function Documentation

FW::ProcessCode FW::BField::BFieldScalor::decorate ( AlgorithmContext &  context )

finaloverridevirtual

decorates (adds, modifies) the AlgorithmContext with a geometric rotation per event

Note

If decorators depend on each other, they have to be added in order.

Parameters

context

the bare (or at least non-const) Event context

Implements FW::IContextDecorator.

Definition at line 20 of file BFieldScalor.cpp.

View newest version in sPHENIX GitHub at line 20 of file BFieldScalor.cpp

References FW::AlgorithmContext::eventNumber, FW::AlgorithmContext::magFieldContext, and SUCCESS.

const Acts::Logger& FW::BField::BFieldScalor::logger ( ) const

inlineprivate

Private access to the logging instance.

Definition at line 62 of file BFieldScalor.hpp.

View newest version in sPHENIX GitHub at line 62 of file BFieldScalor.hpp

References m_logger.

const std::string& FW::BField::BFieldScalor::name ( ) const

inlinefinaloverridevirtual

decorator name() for screen output

Implements FW::IContextDecorator.

Definition at line 54 of file BFieldScalor.hpp.

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

References m_name.

Member Data Documentation

Config FW::BField::BFieldScalor::m_cfg

private

the configuration class

Definition at line 57 of file BFieldScalor.hpp.

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

std::unique_ptr<const Acts::Logger> FW::BField::BFieldScalor::m_logger

private

Definition at line 58 of file BFieldScalor.hpp.

View newest version in sPHENIX GitHub at line 58 of file BFieldScalor.hpp

Referenced by logger().

std::string FW::BField::BFieldScalor::m_name = "BFieldScalor"

private

!< the logging instance

Definition at line 59 of file BFieldScalor.hpp.

View newest version in sPHENIX GitHub at line 59 of file BFieldScalor.hpp

Referenced by name().

---

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

• acts/blob/master/Examples/Detectors/MagneticField/include/ACTFW/Plugins/BField/BFieldScalor.hpp
• acts/blob/master/Examples/Detectors/MagneticField/src/BFieldScalor.cpp