EL::AnaAlgorithmWrapper Class Reference

an IAlgorithmWrapper for AnaAlgorithm More...

#include <AnaAlgorithmWrapper.h>

Inheritance diagram for EL::AnaAlgorithmWrapper:

Collaboration diagram for EL::AnaAlgorithmWrapper:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	AnaAlgorithmWrapper ()
	standard default constructor for serialization
	AnaAlgorithmWrapper (AnaAlgorithmConfig val_config)
	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 StatusCode	initialize (const AlgorithmWorkerData &workerData) override
	call initialize on the algorithm
virtual StatusCode	execute () override
	call execute 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
virtual Algorithm *	getLegacyAlg ()
	get the legacy algorithm, if we wrap one
virtual StatusCode	postExecute ()
	call postExecute on the algorithm

Private Attributes
AnaAlgorithmConfig	m_config
	the algorithm configuration
std::unique_ptr< AnaAlgorithm >	m_algorithm
	the actual algorithm (once instantiated)

Detailed Description

an IAlgorithmWrapper for AnaAlgorithm

Definition at line 22 of file AnaAlgorithmWrapper.h.

Constructor & Destructor Documentation

AnaAlgorithmWrapper() [1/2]

EL::AnaAlgorithmWrapper::AnaAlgorithmWrapper ( )

inline

standard default constructor for serialization

Definition at line 33 of file AnaAlgorithmWrapper.h.

{};

AnaAlgorithmWrapper() [2/2]

EL::AnaAlgorithmWrapper::AnaAlgorithmWrapper

(

AnaAlgorithmConfig

val_config

)

standard constructor

Definition at line 30 of file AnaAlgorithmWrapper.cxx.

    : m_config (std::move (val_config))
  {
    RCU_NEW_INVARIANT (this);
  }

Member Function Documentation

beginInputFile()

StatusCode EL::AnaAlgorithmWrapper::beginInputFile ( )

overridevirtual

call beginInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 129 of file AnaAlgorithmWrapper.cxx.

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

endInputFile()

StatusCode EL::AnaAlgorithmWrapper::endInputFile ( )

overridevirtual

call endInputFile on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 147 of file AnaAlgorithmWrapper.cxx.

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

execute()

StatusCode EL::AnaAlgorithmWrapper::execute ( )

overridevirtual

call execute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 81 of file AnaAlgorithmWrapper.cxx.

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

fileExecute()

StatusCode EL::AnaAlgorithmWrapper::fileExecute ( )

overridevirtual

call fileExecute on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 111 of file AnaAlgorithmWrapper.cxx.

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

finalize()

StatusCode EL::AnaAlgorithmWrapper::finalize ( )

overridevirtual

call finalize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 96 of file AnaAlgorithmWrapper.cxx.

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

getLegacyAlg()

virtual Algorithm * EL::IAlgorithmWrapper::getLegacyAlg ( )

inlinevirtualinherited

get the legacy algorithm, if we wrap one

Reimplemented in EL::AlgorithmMemoryWrapper, EL::AlgorithmTimerWrapper, and EL::AlgorithmWrapper.

Definition at line 64 of file IAlgorithmWrapper.h.

{return nullptr;};

getName()

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

overridevirtual

Inherited Members

Implements EL::IAlgorithmWrapper.

Definition at line 39 of file AnaAlgorithmWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_config.name();
  }

hasName()

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

overridevirtual

whether this algorithm has the given name

Implements EL::IAlgorithmWrapper.

Definition at line 48 of file AnaAlgorithmWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_config.name() == name;
  }

initialize()

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

overridevirtual

call initialize on the algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 66 of file AnaAlgorithmWrapper.cxx.

  {
    using namespace msgAlgorithmConfig;
    RCU_CHANGE_INVARIANT (this);
    if (m_config.makeAlgorithm (m_algorithm, workerData).isFailure())
    {
      ANA_MSG_ERROR ("failed to create AnaAlgorithm: " << m_config.name());
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  }

makeClone()

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

overridevirtual

make a clone of this algorithm

Implements EL::IAlgorithmWrapper.

Definition at line 57 of file AnaAlgorithmWrapper.cxx.

  {
    RCU_READ_INVARIANT (this);
    return std::make_unique<AnaAlgorithmWrapper> (m_config);
  }

postExecute()

virtual StatusCode EL::IAlgorithmWrapper::postExecute ( )

inlinevirtualinherited

call postExecute on the algorithm

Reimplemented in EL::AlgorithmMemoryWrapper, EL::AlgorithmTimerWrapper, and EL::AlgorithmWrapper.

Definition at line 73 of file IAlgorithmWrapper.h.

{return StatusCode::SUCCESS;};

testInvariant()

void EL::AnaAlgorithmWrapper::testInvariant

(

)

const

test the invariant of this object

Public Members

Definition at line 22 of file AnaAlgorithmWrapper.cxx.

  {
    RCU_INVARIANT (!m_config.name().empty());
  }

Member Data Documentation

m_algorithm

std::unique_ptr<AnaAlgorithm> EL::AnaAlgorithmWrapper::m_algorithm

private

the actual algorithm (once instantiated)

Please note (and do not remove) the comment at the end of the line. This specifically excludes this member from serialization.

Definition at line 76 of file AnaAlgorithmWrapper.h.

m_config

AnaAlgorithmConfig EL::AnaAlgorithmWrapper::m_config

private

the algorithm configuration

Private Members

Definition at line 69 of file AnaAlgorithmWrapper.h.

---

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

• AnaAlgorithmWrapper.h
• AnaAlgorithmWrapper.cxx