EL::AlgorithmWrapper Class Reference

an IAlgorithmWrapper for AnaAlgorithm More...

#include <AlgorithmWrapper.h>

Inheritance diagram for EL::AlgorithmWrapper:

Collaboration diagram for EL::AlgorithmWrapper:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	AlgorithmWrapper ()
	standard default constructor for serialization
	AlgorithmWrapper (std::unique_ptr< Algorithm > &&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 (const EventContext &ctx) 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< Algorithm >	m_algorithm
	the actual algorithm
bool	m_firstFile {true}
	whether this is the first file we encounter
bool	m_isInitialized {false}
	whether Algorithm::initialize has been called

Detailed Description

an IAlgorithmWrapper for AnaAlgorithm

Definition at line 22 of file AlgorithmWrapper.h.

Constructor & Destructor Documentation

AlgorithmWrapper() [1/2]

EL::AlgorithmWrapper::AlgorithmWrapper ( )

inline

standard default constructor for serialization

Definition at line 33 of file AlgorithmWrapper.h.

{};

AlgorithmWrapper() [2/2]

EL::AlgorithmWrapper::AlgorithmWrapper

(

std::unique_ptr< Algorithm > &&

val_algorithm

)

standard constructor

Definition at line 38 of file AlgorithmWrapper.cxx.

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

Member Function Documentation

beginInputFile()

StatusCode EL::AlgorithmWrapper::beginInputFile ( )

overridevirtual

call beginInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 179 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_algorithm->changeInput(m_firstFile).isFailure())
    {
      ANA_MSG_ERROR ("failed to call changeInput() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    m_firstFile = false;
    if (m_isInitialized == false && m_algorithm->m_wk->hasInputEvents())
    {
      if (m_algorithm->initialize().isFailure())
      {
        ANA_MSG_ERROR ("failed to call initialize() on algorithm: " << m_algorithm->name());
        return StatusCode::FAILURE;
      }
      m_isInitialized = true;
    }
    return StatusCode::SUCCESS;
  }

endInputFile()

StatusCode EL::AlgorithmWrapper::endInputFile ( )

overridevirtual

call endInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 205 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_algorithm->endOfFile().isFailure())
    {
      ANA_MSG_ERROR ("failed to call endOfFile() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

execute()

StatusCode EL::AlgorithmWrapper::execute ( const EventContext & ctx )

overridevirtual

call execute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 107 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_algorithm->execute().isFailure())
    {
      ANA_MSG_ERROR ("failed to call execute() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

fileExecute()

StatusCode EL::AlgorithmWrapper::fileExecute ( )

overridevirtual

call fileExecute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 163 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_algorithm->fileExecute().isFailure())
    {
      ANA_MSG_ERROR ("failed to call fileExecute() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

finalize()

StatusCode EL::AlgorithmWrapper::finalize ( )

overridevirtual

call finalize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 139 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_isInitialized == true)
    {
      if (m_algorithm->finalize().isFailure())
      {
        ANA_MSG_ERROR ("failed to call finalize() on algorithm: " << m_algorithm->name());
        return StatusCode::FAILURE;
      }
    }
    if (m_algorithm->histFinalize().isFailure())
    {
      ANA_MSG_ERROR ("failed to call histFinalize() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

getLegacyAlg()

Algorithm * EL::AlgorithmWrapper::getLegacyAlg ( )

overridevirtual

get the legacy algorithm, if we wrap one

Reimplemented from EL::IAlgorithmWrapper.

Definition at line 80 of file AlgorithmWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_algorithm.get();
  }

getName()

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

overridevirtual

Inherited Members

Implements EL::IAlgorithmWrapper.

Definition at line 47 of file AlgorithmWrapper.cxx.

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

hasName()

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

overridevirtual

whether this algorithm has the given name

Implements EL::IAlgorithmWrapper.

Definition at line 56 of file AlgorithmWrapper.cxx.

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

initialize()

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

overridevirtual

call initialize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 89 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    m_algorithm->m_wk = workerData.m_wk;
    m_algorithm->m_evtStorePtr = workerData.m_evtStore;
    if (m_algorithm->histInitialize().isFailure())
    {
      ANA_MSG_ERROR ("failed to call histInitialize() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

makeClone()

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

overridevirtual

make a clone of this algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 65 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_READ_INVARIANT (this);
 
    std::unique_ptr<Algorithm> myalgorithm
      (dynamic_cast<Algorithm*>(m_algorithm->Clone ()));
    if (myalgorithm == nullptr)
      throw std::runtime_error (std::format ("failed to clone algorithm {}", m_algorithm->GetName()));
    return std::make_unique<AlgorithmWrapper> (std::move (myalgorithm));
  }

postExecute()

StatusCode EL::AlgorithmWrapper::postExecute ( )

overridevirtual

call postExecute on the algorithm

Reimplemented from EL::IAlgorithmWrapper.

Definition at line 123 of file AlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
 
    if (m_algorithm->postExecute().isFailure())
    {
      ANA_MSG_ERROR ("failed to call postExecute() on algorithm: " << m_algorithm->name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

testInvariant()

void EL::AlgorithmWrapper::testInvariant

(

)

const

test the invariant of this object

Public Members

Definition at line 31 of file AlgorithmWrapper.cxx.

  {
  }

Member Data Documentation

m_algorithm

std::unique_ptr<Algorithm> EL::AlgorithmWrapper::m_algorithm

private

the actual algorithm

Private Members

Definition at line 73 of file AlgorithmWrapper.h.

m_firstFile

bool EL::AlgorithmWrapper::m_firstFile {true}

private

whether this is the first file we encounter

Definition at line 76 of file AlgorithmWrapper.h.

{true};

m_isInitialized

bool EL::AlgorithmWrapper::m_isInitialized {false}

private

whether Algorithm::initialize has been called

Definition at line 79 of file AlgorithmWrapper.h.

{false};

---

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

• AlgorithmWrapper.h
• AlgorithmWrapper.cxx