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

#include <acts/blob/sPHENIX/Examples/Detectors/MagneticField/include/ActsExamples/MagneticField/ScalableBFieldService.hpp>

+ Inheritance diagram for ActsExamples::ScalableBFieldService:
+ Collaboration diagram for ActsExamples::ScalableBFieldService:

Classes

struct  Config
 

Public Member Functions

 ScalableBFieldService (const Config &cfg, Acts::Logging::Level lvl)
 
const std::string & name () const override
 The service name.
 
ProcessCode decorate (AlgorithmContext &ctx) override
 
- Public Member Functions inherited from ActsExamples::IContextDecorator
virtual ~IContextDecorator ()=default
 Virtual destructor.
 

Private Member Functions

const Acts::Loggerlogger () const
 

Private Attributes

Config m_cfg
 
std::unique_ptr< const
Acts::Logger
m_logger
 

Detailed Description

A mock service that changes the magnetic field scale for each event.

The magnetic field scaling changes as some function of the event number.

Definition at line 25 of file ScalableBFieldService.hpp.

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

Constructor & Destructor Documentation

ActsExamples::ScalableBFieldService::ScalableBFieldService ( const Config cfg,
Acts::Logging::Level  lvl 
)

Construct the magnetic field service.

Parameters
cfgConfiguration struct
lvlLogging level

Definition at line 22 of file ScalableBFieldService.cpp.

View newest version in sPHENIX GitHub at line 22 of file ScalableBFieldService.cpp

Member Function Documentation

ActsExamples::ProcessCode ActsExamples::ScalableBFieldService::decorate ( AlgorithmContext ctx)
overridevirtual

Update the magnetic field context.

Parameters
ctxThe per-event context

Implements ActsExamples::IContextDecorator.

Definition at line 30 of file ScalableBFieldService.cpp.

View newest version in sPHENIX GitHub at line 30 of file ScalableBFieldService.cpp

References ActsExamples::AlgorithmContext::eventNumber, m_cfg(), magCtx, ActsExamples::AlgorithmContext::magFieldContext, ActsExamples::ScalableBFieldContext::scalor, and SUCCESS.

+ Here is the call graph for this function:

const Acts::Logger& ActsExamples::ScalableBFieldService::logger ( ) const
inlineprivate

Definition at line 50 of file ScalableBFieldService.hpp.

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

References m_logger.

const std::string & ActsExamples::ScalableBFieldService::name ( ) const
overridevirtual

The service name.

Implements ActsExamples::IContextDecorator.

Definition at line 26 of file ScalableBFieldService.cpp.

View newest version in sPHENIX GitHub at line 26 of file ScalableBFieldService.cpp

Member Data Documentation

Config ActsExamples::ScalableBFieldService::m_cfg
private

Definition at line 47 of file ScalableBFieldService.hpp.

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

std::unique_ptr<const Acts::Logger> ActsExamples::ScalableBFieldService::m_logger
private

Definition at line 48 of file ScalableBFieldService.hpp.

View newest version in sPHENIX GitHub at line 48 of file ScalableBFieldService.hpp

Referenced by logger().


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