GaudiPython::PyAlg< ALGORITHM > Class Template Reference

general class to embed the existing algorithm/base class into the python More...

#include <GaudiPython/Algorithm.h>

Inheritance diagram for GaudiPython::PyAlg< ALGORITHM >:

Collaboration diagram for GaudiPython::PyAlg< ALGORITHM >:

Public Member Functions
	PyAlg (PyObject *self, const std::string &name)
	constructor from Python object and the name More...
StatusCode	initialize () override
StatusCode	start () override
StatusCode	execute () override
StatusCode	stop () override
StatusCode	finalize () override
virtual IAlgorithm *	ialgorithm ()
virtual IProperty *	iproperty ()
virtual StatusCode	initialize_ ()
virtual StatusCode	finalize_ ()

Protected Member Functions
PyObject *	_obj () const
	get the object More...

Private Member Functions
	PyAlg ()=delete
	the default constructor is disabled More...
	PyAlg (const PyAlg &)=delete
	the copy constructor is disabled More...
PyAlg &	operator= (const PyAlg &)=delete
	the assignment operator is disabled More...

Private Attributes
PyObject *	m_self
	"shadow" python class More...

Detailed Description

template<class ALGORITHM>
class GaudiPython::PyAlg< ALGORITHM >

general class to embed the existing algorithm/base class into the python

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@l.nosp@m.app..nosp@m.in2p3.nosp@m..fr

Date

2005-08-03

Definition at line 67 of file Algorithm.h.

Constructor & Destructor Documentation

PyAlg() [1/3]

template<class ALGORITHM >

GaudiPython::PyAlg< ALGORITHM >::PyAlg ( PyObject *  self, const std::string &  name  )

inline

constructor from Python object and the name

Parameters

self	python object
name	name of algorithm instance

Definition at line 75 of file Algorithm.h.

                                                   : 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();
    }

PyAlg() [2/3]

template<class ALGORITHM >

GaudiPython::PyAlg< ALGORITHM >::PyAlg ( )

privatedelete

the default constructor is disabled

PyAlg() [3/3]

template<class ALGORITHM >

GaudiPython::PyAlg< ALGORITHM >::PyAlg ( const PyAlg< ALGORITHM > &  )

privatedelete

the copy constructor is disabled

Member Function Documentation

_obj()

template<class ALGORITHM >

PyObject* GaudiPython::PyAlg< ALGORITHM >::_obj ( ) const

inlineprotected

get the object

Definition at line 88 of file Algorithm.h.

{ return m_self; } //     get the object

execute()

template<class ALGORITHM >

StatusCode GaudiPython::PyAlg< ALGORITHM >::execute ( )

inlineoverride

Definition at line 94 of file Algorithm.h.

{ return GaudiPython::call_python_method( m_self, "execute" ); }

finalize()

template<class ALGORITHM >

StatusCode GaudiPython::PyAlg< ALGORITHM >::finalize ( )

inlineoverride

Definition at line 96 of file Algorithm.h.

{ return GaudiPython::call_python_method( m_self, "finalize" ); }

finalize_()

template<class ALGORITHM >

virtual StatusCode GaudiPython::PyAlg< ALGORITHM >::finalize_ ( )

inlinevirtual

Definition at line 103 of file Algorithm.h.

{ return ALGORITHM::finalize(); }

ialgorithm()

template<class ALGORITHM >

virtual IAlgorithm* GaudiPython::PyAlg< ALGORITHM >::ialgorithm ( )

inlinevirtual

Definition at line 98 of file Algorithm.h.

{ return this; }

initialize()

template<class ALGORITHM >

StatusCode GaudiPython::PyAlg< ALGORITHM >::initialize ( )

inlineoverride

Definition at line 92 of file Algorithm.h.

{ return GaudiPython::call_python_method( m_self, "initialize" ); }

initialize_()

template<class ALGORITHM >

virtual StatusCode GaudiPython::PyAlg< ALGORITHM >::initialize_ ( )

inlinevirtual

Definition at line 102 of file Algorithm.h.

{ return ALGORITHM::initialize(); }

iproperty()

template<class ALGORITHM >

virtual IProperty* GaudiPython::PyAlg< ALGORITHM >::iproperty ( )

inlinevirtual

Definition at line 99 of file Algorithm.h.

{ return this; }

operator=()

template<class ALGORITHM >

PyAlg& GaudiPython::PyAlg< ALGORITHM >::operator= ( const PyAlg< ALGORITHM > &  )

privatedelete

the assignment operator is disabled

start()

template<class ALGORITHM >

StatusCode GaudiPython::PyAlg< ALGORITHM >::start ( )

inlineoverride

Definition at line 93 of file Algorithm.h.

{ return GaudiPython::call_python_method( m_self, "start" ); }

stop()

template<class ALGORITHM >

StatusCode GaudiPython::PyAlg< ALGORITHM >::stop ( )

inlineoverride

Definition at line 95 of file Algorithm.h.

{ return GaudiPython::call_python_method( m_self, "stop" ); }

Member Data Documentation

m_self

template<class ALGORITHM >

PyObject* GaudiPython::PyAlg< ALGORITHM >::m_self

private

"shadow" python class

Definition at line 117 of file Algorithm.h.

---

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

• GaudiPython/GaudiPython/Algorithm.h