EL::AlgorithmTimerWrapper Class Reference

an IAlgorithmWrapper that adds a timer to an algorithm More...

#include <AlgorithmTimerWrapper.h>

Inheritance diagram for EL::AlgorithmTimerWrapper:

Collaboration diagram for EL::AlgorithmTimerWrapper:

Public Types
using	clock_type = std::chrono::high_resolution_clock
	the clock we use for our timer

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	AlgorithmTimerWrapper ()
	standard default constructor for serialization
	AlgorithmTimerWrapper (std::unique_ptr< IAlgorithmWrapper > &&val_algorithm)
	standard constructor
virtual std::string_view	getName () const override
virtual bool	hasName (const std::string &name) const override
	whether this algorithm has the given name
virtual std::unique_ptr< IAlgorithmWrapper >	makeClone () const override
	make a clone of this algorithm
virtual Algorithm *	getLegacyAlg () override
	get the legacy algorithm, if we wrap one
virtual StatusCode	initialize (const AlgorithmWorkerData &workerData) override
	call initialize on the algorithm
virtual StatusCode	execute () override
	call execute on the algorithm
virtual StatusCode	postExecute () override
	call postExecute on the algorithm
virtual StatusCode	finalize () override
	call finalize on the algorithm
virtual::StatusCode	fileExecute () override
	call fileExecute on the algorithm
virtual::StatusCode	beginInputFile () override
	call beginInputFile on the algorithm
virtual::StatusCode	endInputFile () override
	call endInputFile on the algorithm

Private Attributes
std::unique_ptr< IAlgorithmWrapper >	m_algorithm
	the actual algorithm
clock_type::duration	m_time_global {}
	the timers for different calls
clock_type::duration	m_time_file {}
clock_type::duration	m_time_event {}

Detailed Description

an IAlgorithmWrapper that adds a timer to an algorithm

Note

There is a dedicated test in AnalysisAlgorithms config that runs a test job with this module enabled to ensure it runs and doesn't break the output.

Definition at line 26 of file AlgorithmTimerWrapper.h.

Member Typedef Documentation

clock_type

using EL::AlgorithmTimerWrapper::clock_type = std::chrono::high_resolution_clock

the clock we use for our timer

Public Members

Definition at line 34 of file AlgorithmTimerWrapper.h.

Constructor & Destructor Documentation

AlgorithmTimerWrapper() [1/2]

EL::AlgorithmTimerWrapper::AlgorithmTimerWrapper ( )

inline

standard default constructor for serialization

Definition at line 40 of file AlgorithmTimerWrapper.h.

{};

AlgorithmTimerWrapper() [2/2]

EL::AlgorithmTimerWrapper::AlgorithmTimerWrapper

(

std::unique_ptr< IAlgorithmWrapper > &&

val_algorithm

)

standard constructor

Definition at line 33 of file AlgorithmTimerWrapper.cxx.

    : m_algorithm (std::move (val_algorithm))
  {
    RCU_NEW_INVARIANT (this);
  }

Member Function Documentation

beginInputFile()

StatusCode EL::AlgorithmTimerWrapper::beginInputFile ( )

overridevirtual

call beginInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 159 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->beginInputFile ();
    auto stop = clock_type::now();
    m_time_file += stop - start;
    return result;
  }

endInputFile()

StatusCode EL::AlgorithmTimerWrapper::endInputFile ( )

overridevirtual

call endInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 174 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->endInputFile ();
    auto stop = clock_type::now();
    m_time_file += stop - start;
    return result;
  }

execute()

StatusCode EL::AlgorithmTimerWrapper::execute ( )

overridevirtual

call execute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 95 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->execute ();
    auto stop = clock_type::now();
    m_time_event += stop - start;
    return result;
  }

fileExecute()

StatusCode EL::AlgorithmTimerWrapper::fileExecute ( )

overridevirtual

call fileExecute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 144 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->fileExecute ();
    auto stop = clock_type::now();
    m_time_file += stop - start;
    return result;
  }

finalize()

StatusCode EL::AlgorithmTimerWrapper::finalize ( )

overridevirtual

call finalize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 125 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->finalize ();
    auto stop = clock_type::now();
    m_time_global += stop - start;
    auto seconds = std::chrono::duration<float>(1);
    std::ostringstream str;
    str << std::setprecision(2) << std::fixed << "algorithm timer: " << m_algorithm->getName() << " " << (m_time_event/seconds)  << " " << (m_time_file/seconds) << " " << (m_time_global/seconds);
    ANA_MSG_INFO (str.str());
    return result;
  }

getLegacyAlg()

Algorithm * EL::AlgorithmTimerWrapper::getLegacyAlg ( )

overridevirtual

get the legacy algorithm, if we wrap one

Reimplemented from EL::IAlgorithmWrapper.

Definition at line 71 of file AlgorithmTimerWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_algorithm->getLegacyAlg();
  }

getName()

std::string_view EL::AlgorithmTimerWrapper::getName ( ) const

overridevirtual

Inherited Members

Implements EL::IAlgorithmWrapper.

Definition at line 42 of file AlgorithmTimerWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_algorithm->getName();
  }

hasName()

bool EL::AlgorithmTimerWrapper::hasName ( const std::string & name ) const

overridevirtual

whether this algorithm has the given name

Implements EL::IAlgorithmWrapper.

Definition at line 51 of file AlgorithmTimerWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_algorithm->hasName (name);
  }

initialize()

StatusCode EL::AlgorithmTimerWrapper::initialize ( const AlgorithmWorkerData & workerData )

overridevirtual

call initialize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 80 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->initialize (workerData);
    auto stop = clock_type::now();
    m_time_global += stop - start;
    return result;
  }

makeClone()

std::unique_ptr< IAlgorithmWrapper > EL::AlgorithmTimerWrapper::makeClone ( ) const

overridevirtual

make a clone of this algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 60 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_READ_INVARIANT (this);
 
    return std::make_unique<AlgorithmTimerWrapper> (m_algorithm->makeClone());
  }

postExecute()

StatusCode EL::AlgorithmTimerWrapper::postExecute ( )

overridevirtual

call postExecute on the algorithm

Reimplemented from EL::IAlgorithmWrapper.

Definition at line 110 of file AlgorithmTimerWrapper.cxx.

  {
    using namespace msgEventLoop;
    RCU_CHANGE_INVARIANT (this);
 
    auto start = clock_type::now();
    auto result = m_algorithm->postExecute ();
    auto stop = clock_type::now();
    m_time_event += stop - start;
    return result;
  }

testInvariant()

void EL::AlgorithmTimerWrapper::testInvariant

(

)

const

test the invariant of this object

Definition at line 26 of file AlgorithmTimerWrapper.cxx.

  {
  }

Member Data Documentation

m_algorithm

std::unique_ptr<IAlgorithmWrapper> EL::AlgorithmTimerWrapper::m_algorithm

private

the actual algorithm

Private Members

Definition at line 82 of file AlgorithmTimerWrapper.h.

m_time_event

clock_type::duration EL::AlgorithmTimerWrapper::m_time_event {}

private

Definition at line 87 of file AlgorithmTimerWrapper.h.

{};

m_time_file

clock_type::duration EL::AlgorithmTimerWrapper::m_time_file {}

private

Definition at line 86 of file AlgorithmTimerWrapper.h.

{};

m_time_global

clock_type::duration EL::AlgorithmTimerWrapper::m_time_global {}

private

the timers for different calls

Definition at line 85 of file AlgorithmTimerWrapper.h.

{};

---

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

• AlgorithmTimerWrapper.h
• AlgorithmTimerWrapper.cxx