ActsExamples::IService Class Reference

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

Inheritance diagram for ActsExamples::IService:

Public Member Functions
virtual	~IService ()=default
virtual std::string	name () const =0
	The service name.
virtual void	startRun ()=0
virtual void	prepare (AlgorithmContext &ctx)=0

Detailed Description

Service interface.

A service should be used to provide constant or slowly changing per-event information, e.g. geometry with or without alignment, magnetic field, ..., and to handle once-per-run tasks. In contrast to an algorithm (i.e. inheriting from IAlgorithm), a service can have an internal state and each implementation has to ensure that concurrent calls are valid.

Definition at line 32 of file IService.hpp.

View newest version in sPHENIX GitHub at line 32 of file IService.hpp

Constructor & Destructor Documentation

virtual ActsExamples::IService::~IService ( )

virtualdefault

Member Function Documentation

virtual std::string ActsExamples::IService::name ( ) const

pure virtual

The service name.

Implemented in ActsExamples::BareService.

Referenced by eicpy.verify.PythiaHistograms::__init__(), and eicpy.verify.DjangohHistograms::__init__().

Here is the caller graph for this function:

virtual void ActsExamples::IService::prepare ( AlgorithmContext &  ctx )

pure virtual

Prepare per-event information.

This is intended to add already existing information, e.g. geometry or conditions data, to the event store. While possible, complex operations should be better implemented as an regular algorithm.

Should throw an exception on non-recoverable errors.

Implemented in ActsExamples::BareService, and ActsExamples::HelloService.

virtual void ActsExamples::IService::startRun ( )

pure virtual

Start-of-run hook to be called before any events are processed.

Should throw an exception for non-recoverable errors.

Implemented in ActsExamples::BareService, and ActsExamples::HelloService.

---

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

• acts/blob/sPHENIX/Examples/Framework/include/ActsExamples/Framework/IService.hpp