Algorithm.h

Go to the documentation of this file.

#ifndef GAUDIPYTHON_ALGORITHM_H
#define GAUDIPYTHON_ALGORITHM_H
// ============================================================================
// Include Files
// ============================================================================
// Python
// ============================================================================
#include "Python.h"
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/Algorithm.h"
#include "GaudiKernel/Bootstrap.h"
// ============================================================================
// GaudiPython
// ============================================================================
#include "GaudiPython/GaudiPython.h"
// ============================================================================

namespace GaudiPython
{
  GAUDI_API StatusCode call_python_method ( PyObject* self , const char* method ) ;
}

namespace GaudiPython
{

  class GAUDI_API PyAlgorithm : public Algorithm
  {
  public:
    PyAlgorithm
    ( PyObject*          self ,
      const std::string& name ) ;
  public:
    StatusCode  initialize () ;
    StatusCode  start      () ;
    StatusCode  beginRun   () ;
    StatusCode  endRun     () ;
    StatusCode  execute    () ;
    StatusCode  stop       () ;
    StatusCode  finalize   () ;
    IAlgorithm* myself() { return this; }
  private:
    PyObject* m_self;
  };
  // ==========================================================================
  template <class ALGORITHM>
  class GAUDI_API PyAlg : public          ALGORITHM
  {
    // ========================================================================
  public:
    // ========================================================================
    PyAlg
    ( PyObject*          self ,
      const std::string& name )
      : ALGORITHM ( name , Gaudi::svcLocator() )
      , m_self ( self )
    {
      // the printout of actual type for embedded algorithm has no sense
      this->setProperty ( "TypePrint" , "false" ) ;
      this->setProperty ( "StatPrint" , "true"  ) ;
      // The owner of the Algorithm is Python (as creator) therefore
      // it should not be deleted by Gaudi (added an extra addRef()).
      this->addRef() ;
      this->addRef() ;
    }
    // ========================================================================
  protected:
    // ========================================================================
    ~PyAlg() override = default;                           // virtual destructor
    PyObject* _obj() const { return m_self ; }            //     get the object
    // ========================================================================
  public:
    // ========================================================================
    StatusCode initialize  () override
    { return GaudiPython::call_python_method ( m_self , "initialize" ) ; }
    StatusCode start  () override
    { return GaudiPython::call_python_method ( m_self , "start"      ) ; }
    StatusCode beginRun  () override
    { return GaudiPython::call_python_method ( m_self , "beginRun"   ) ; }
    StatusCode endRun  () override
    { return GaudiPython::call_python_method ( m_self , "endRun"     ) ; }
    StatusCode execute     () override
    { return GaudiPython::call_python_method ( m_self , "execute"    ) ; }
    StatusCode stop  () override
    { return GaudiPython::call_python_method ( m_self , "stop"       ) ; }
    StatusCode finalize    () override
    { return GaudiPython::call_python_method ( m_self , "finalize"   ) ; }
    // ========================================================================
    virtual IAlgorithm* ialgorithm () { return this ; }
    virtual IProperty*  iproperty  () { return this ; }
    // ========================================================================
    // preserve the existing methods
    virtual StatusCode initialize_ () { return ALGORITHM::initialize () ; }
    virtual StatusCode finalize_   () { return ALGORITHM::finalize   () ; }
    // ========================================================================
  private:
    // ========================================================================
    PyAlg() = delete;
    PyAlg ( const PyAlg& ) = delete; 
    PyAlg& operator=( const PyAlg& )  = delete;
    // ========================================================================
  private:
    // ========================================================================
    PyObject* m_self;                                  // "shadow" python class
    // ========================================================================
  } ;
  // ==========================================================================
} //                                               end of namespace GaudiPython
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIPYTHON_ALGORITHM_H
// ============================================================================