GaudiPython::PyAlgorithm Class Reference

Python Algorithm base class. More...

#include </tmp/marcocle/lhcb-release/1122/GAUDI/GAUDI_v27r0/InstallArea/x86_64-slc6-gcc49-opt/include/GaudiPython/Algorithm.h>

Inheritance diagram for GaudiPython::PyAlgorithm:

Collaboration diagram for GaudiPython::PyAlgorithm:

Public Member Functions
	PyAlgorithm (PyObject *self, const std::string &name)
	constructor More...
StatusCode	initialize ()
StatusCode	start ()
StatusCode	beginRun ()
StatusCode	endRun ()
StatusCode	execute ()
StatusCode	stop ()
StatusCode	finalize ()
IAlgorithm *	myself ()
	PyAlgorithm (PyObject *self, const std::string &name)
	constructor More...
StatusCode	initialize ()
StatusCode	start ()
StatusCode	beginRun ()
StatusCode	endRun ()
StatusCode	execute ()
StatusCode	stop ()
StatusCode	finalize ()
IAlgorithm *	myself ()
Public Member Functions inherited from Algorithm
	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...
	~Algorithm () override=default
	Destructor. More...
StatusCode	sysStart () override
	Reinitialization method invoked by the framework. More...
StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...
StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework. More...
StatusCode	sysRestart () override
	Restart method invoked by the framework. More...
StatusCode	sysExecute () override
	The actions to be performed by the algorithm on an event. More...
StatusCode	sysStop () override
	System stop. More...
StatusCode	sysFinalize () override
	System finalization. More...
StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...
StatusCode	sysEndRun () override
	endRun method invoked by the framework. More...
const std::string &	name () const override
	The identifying name of the algorithm object. More...
const std::string &	type () const override
	The type of the algorithm object. More...
void	setType (const std::string &type) override
const std::string &	version () const override
unsigned int	index () override
StatusCode	configure () override
	Dummy implementation of IStateful::configure() method. More...
StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method. More...
StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method More...
StatusCode	start () override
	the default (empty) implementation of IStateful::start() method More...
StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method More...
StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method More...
StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method More...
StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method More...
Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm More...
Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition More...
bool	isExecuted () const override
	Has this algorithm been executed since the last reset? More...
void	setExecuted (bool state) override
	Set the executed flag to the specified state. More...
void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...
StatusCode	beginRun () override
	Algorithm begin run. More...
StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...
bool	isEnabled () const override
	Is this algorithm enabled or disabled? More...
bool	filterPassed () const override
	Did this algorithm pass or fail its filter criterion for the last event? More...
void	setFilterPassed (bool state) override
	Set the filter passed flag to the specified state. More...
int	errorCount () const
	Get the number of failures of the algorithm. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...
template<class T >
SmartIF< T >	service (const std::string &name, bool createIf=true, bool quiet=false) const
void	setOutputLevel (int level)
	Set the output level for current algorithm. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...
SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...
SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...
SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...
SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...
SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...
SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...
SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...
SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...
SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...
SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...
SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...
SmartIF< ITimelineSvc > &	timelineSvc () const
SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...
SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...
SmartIF< IHiveWhiteBoard > &	whiteboard () const
bool	registerContext () const
	register for Algorithm Context Service? More...
StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...
const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
StatusCode	setProperty (const Property &p) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...
StatusCode	getProperty (Property *p) const override
	Implementation of IProperty::getProperty. More...
const Property &	getProperty (const std::string &name) const override
	Implementation of IProperty::getProperty. More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...
const std::vector< Property * > &	getProperties () const override
	Implementation of IProperty::getProperties. More...
bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...
StatusCode	setProperties ()
	Set the algorithm's properties. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...
SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...
template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
EventContext *	getContext ()
	get the context More...
void	setContext (EventContext *context)
	set the context More...
template<typename T >
	__attribute__ ((deprecated)) StatusCode declareDataObj(const std
	Declare data object. More...
template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...
template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::vector< std::string > &addresses, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...
template<class T >
StatusCode	declareOutput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::WRITE)
	Declare output data object. More...
__attribute__((deprecated)) const std const DataObjectDescriptorCollection &	inputDataObjects () const override
	Return the handles declared in the algorithm. More...
const DataObjectDescriptorCollection &	outputDataObjects () const override
void	registerTool (IAlgTool *tool) const
void	deregisterTool (IAlgTool *tool) const
template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...
const std::vector< IAlgTool * > &	tools () const
bool	isClonable () const override
	Specifies the clonability of the algorithm. More...
unsigned int	cardinality () const override
	Return the cardinality. More...
const std::vector< std::string > &	neededResources () const override
	Algorithm (const std::string &name, ISvcLocator *svcloc, const std::string &version=PACKAGE_VERSION)
	Constructor. More...
	~Algorithm () override=default
	Destructor. More...
StatusCode	sysStart () override
	Reinitialization method invoked by the framework. More...
StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...
StatusCode	sysReinitialize () override
	Reinitialization method invoked by the framework. More...
StatusCode	sysRestart () override
	Restart method invoked by the framework. More...
StatusCode	sysExecute () override
	The actions to be performed by the algorithm on an event. More...
StatusCode	sysStop () override
	System stop. More...
StatusCode	sysFinalize () override
	System finalization. More...
StatusCode	sysBeginRun () override
	beginRun method invoked by the framework. More...
StatusCode	sysEndRun () override
	endRun method invoked by the framework. More...
const std::string &	name () const override
	The identifying name of the algorithm object. More...
const std::string &	type () const override
	The type of the algorithm object. More...
void	setType (const std::string &type) override
const std::string &	version () const override
unsigned int	index () override
StatusCode	configure () override
	Dummy implementation of IStateful::configure() method. More...
StatusCode	terminate () override
	Dummy implementation of IStateful::terminate() method. More...
StatusCode	initialize () override
	the default (empty) implementation of IStateful::initialize() method More...
StatusCode	start () override
	the default (empty) implementation of IStateful::start() method More...
StatusCode	stop () override
	the default (empty) implementation of IStateful::stop() method More...
StatusCode	finalize () override
	the default (empty) implementation of IStateful::finalize() method More...
StatusCode	reinitialize () override
	the default (empty) implementation of IStateful::reinitialize() method More...
StatusCode	restart () override
	the default (empty) implementation of IStateful::restart() method More...
Gaudi::StateMachine::State	FSMState () const override
	returns the current state of the algorithm More...
Gaudi::StateMachine::State	targetFSMState () const override
	returns the state the algorithm will be in after the ongoing transition More...
bool	isExecuted () const override
	Has this algorithm been executed since the last reset? More...
void	setExecuted (bool state) override
	Set the executed flag to the specified state. More...
void	resetExecuted () override
	Reset the executed state of the Algorithm for the duration of the current event. More...
StatusCode	beginRun () override
	Algorithm begin run. More...
StatusCode	endRun () override
	Algorithm end run. This method is called at the end of the event loop. More...
bool	isEnabled () const override
	Is this algorithm enabled or disabled? More...
bool	filterPassed () const override
	Did this algorithm pass or fail its filter criterion for the last event? More...
void	setFilterPassed (bool state) override
	Set the filter passed flag to the specified state. More...
int	errorCount () const
	Get the number of failures of the algorithm. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...
template<class T >
SmartIF< T >	service (const std::string &name, bool createIf=true, bool quiet=false) const
void	setOutputLevel (int level)
	Set the output level for current algorithm. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
SmartIF< IChronoStatSvc > &	chronoSvc () const
	The standard Chrono & Stat service, Return a pointer to the service if present. More...
SmartIF< IChronoStatSvc > &	chronoStatService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IDataProviderSvc > &	detSvc () const
	The standard detector data service. More...
SmartIF< IDataProviderSvc > &	detDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IConversionSvc > &	detCnvSvc () const
	The standard detector data persistency conversion service. More...
SmartIF< IConversionSvc > &	detDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IDataProviderSvc > &	eventSvc () const
	The standard event data service. More...
SmartIF< IDataProviderSvc > &	evtSvc () const
	shortcut for method eventSvc More...
SmartIF< IDataProviderSvc > &	eventDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IConversionSvc > &	eventCnvSvc () const
	The standard event data persistency conversion service. More...
SmartIF< IConversionSvc > &	eventDataCnvService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IHistogramSvc > &	histoSvc () const
	The standard histogram service. More...
SmartIF< IHistogramSvc > &	histogramDataService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
SmartIF< IMessageSvc > &	messageService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< INTupleSvc > &	ntupleSvc () const
	The standard N tuple service. More...
SmartIF< INTupleSvc > &	ntupleService () const
	Obsoleted name, kept due to the backwards compatibility. More...
SmartIF< IRndmGenSvc > &	randSvc () const
	AIDA-based NTuple service Returns a pointer to the AIDATuple service if present. More...
SmartIF< IToolSvc > &	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...
SmartIF< IExceptionSvc > &	exceptionSvc () const
	Get the exception Service. More...
SmartIF< IAlgContextSvc > &	contextSvc () const
	get Algorithm Context Service More...
SmartIF< ITimelineSvc > &	timelineSvc () const
SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...
SmartIF< ISvcLocator > &	svcLoc () const
	shortcut for method serviceLocator More...
SmartIF< IHiveWhiteBoard > &	whiteboard () const
bool	registerContext () const
	register for Algorithm Context Service? More...
StatusCode	createSubAlgorithm (const std::string &type, const std::string &name, Algorithm *&pSubAlg)
	Create a sub algorithm. More...
const std::vector< Algorithm * > *	subAlgorithms () const
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
std::vector< Algorithm * > *	subAlgorithms ()
	List of sub-algorithms. Returns a pointer to a vector of (sub) Algorithms. More...
StatusCode	setProperty (const Property &p) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...
StatusCode	getProperty (Property *p) const override
	Implementation of IProperty::getProperty. More...
const Property &	getProperty (const std::string &name) const override
	Implementation of IProperty::getProperty. More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...
const std::vector< Property * > &	getProperties () const override
	Implementation of IProperty::getProperties. More...
bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...
StatusCode	setProperties ()
	Set the algorithm's properties. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...
SmartIF< IMonitorSvc > &	monitorSvc () const
	Access the monitor service. More...
template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
EventContext *	getContext ()
	get the context More...
void	setContext (EventContext *context)
	set the context More...
template<typename T >
	__attribute__ ((deprecated)) StatusCode declareDataObj(const std
	Declare data object. More...
template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...
template<class T >
StatusCode	declareInput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::vector< std::string > &addresses, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::READ)
	Declare input data object. More...
template<class T >
StatusCode	declareOutput (const std::string &propertyName, DataObjectHandle< T > &handle, const std::string &address=DataObjectDescriptor::NULL_, bool optional=false, MinimalDataObjectHandle::AccessType accessType=MinimalDataObjectHandle::WRITE)
	Declare output data object. More...
__attribute__((deprecated)) const std const DataObjectDescriptorCollection &	inputDataObjects () const override
	Return the handles declared in the algorithm. More...
const DataObjectDescriptorCollection &	outputDataObjects () const override
void	registerTool (IAlgTool *tool) const
void	deregisterTool (IAlgTool *tool) const
template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...
const std::vector< IAlgTool * > &	tools () const
bool	isClonable () const override
	Specifies the clonability of the algorithm. More...
unsigned int	cardinality () const override
	Return the cardinality. More...
const std::vector< std::string > &	neededResources () const override
Public Member Functions inherited from implements< Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
PyObject *	m_self

Additional Inherited Members
Public Types inherited from Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm *, const std::string &, ISvcLocator * >	Factory
typedef Gaudi::PluginService::Factory< IAlgorithm *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from Algorithm
DataObjectDescriptorCollection &	inputDataObjects ()
DataObjectDescriptorCollection &	outputDataObjects ()
std::vector< IAlgTool * > &	tools ()
void	addSubAlgorithmDataObjectHandles ()
bool	isInitialized () const override
	Has the Algorithm already been initialized? More...
bool	isFinalized () const override
	Has the Algorithm already been finalized? More...
int	outputLevel () const
	retrieve the Algorithm output level More...
IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...
void	initOutputLevel (Property &prop)
	Callback for output level property. More...
DataObjectDescriptorCollection &	inputDataObjects ()
DataObjectDescriptorCollection &	outputDataObjects ()
std::vector< IAlgTool * > &	tools ()
void	addSubAlgorithmDataObjectHandles ()
bool	isInitialized () const override
	Has the Algorithm already been initialized? More...
bool	isFinalized () const override
	Has the Algorithm already been finalized? More...
int	outputLevel () const
	retrieve the Algorithm output level More...
IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...
void	initOutputLevel (Property &prop)
	Callback for output level property. More...
Protected Attributes inherited from Algorithm
EventContext *	m_event_context
	Event specific data for multiple event processing. More...
Protected Attributes inherited from implements< Interfaces >
std::atomic_ulong	m_refCount = {0}
	Reference counter. More...

Detailed Description

Python Algorithm base class.

Definition at line 32 of file Algorithm.h.

Constructor & Destructor Documentation

PyAlgorithm::PyAlgorithm	(	PyObject *	self,
		const std::string &	name
	)

constructor

Parameters

self	python objects
name	name of algorithm instance

Definition at line 72 of file Algorithm.cpp.

  : Algorithm ( name , Gaudi::svcLocator() )
  , m_self ( self )
{
  // The owner of the Algorithm is Python (as creator) therefore
  // it should not be deleted by Gaudi (added an extra addRef()).
  addRef() ;
  addRef() ;
}

GaudiPython::PyAlgorithm::PyAlgorithm	(	PyObject *	self,
		const std::string &	name
	)

constructor

Parameters

self	python objects
name	name of algorithm instance

Member Function Documentation

StatusCode PyAlgorithm::beginRun

(

)

Definition at line 100 of file Algorithm.cpp.

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

StatusCode GaudiPython::PyAlgorithm::beginRun

(

)

StatusCode PyAlgorithm::endRun

(

)

Definition at line 102 of file Algorithm.cpp.

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

StatusCode GaudiPython::PyAlgorithm::endRun

(

)

StatusCode PyAlgorithm::execute

(

)

Definition at line 91 of file Algorithm.cpp.

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

StatusCode GaudiPython::PyAlgorithm::execute

(

)

StatusCode PyAlgorithm::finalize

(

)

Definition at line 97 of file Algorithm.cpp.

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

StatusCode GaudiPython::PyAlgorithm::finalize

(

)

StatusCode GaudiPython::PyAlgorithm::initialize

(

)

StatusCode PyAlgorithm::initialize

(

)

Definition at line 85 of file Algorithm.cpp.

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

IAlgorithm* GaudiPython::PyAlgorithm::myself ( )

inline

Definition at line 50 of file Algorithm.h.

{ return this; }

IAlgorithm* GaudiPython::PyAlgorithm::myself ( )

inline

Definition at line 50 of file Algorithm.h.

{ return this; }

StatusCode PyAlgorithm::start

(

)

Definition at line 88 of file Algorithm.cpp.

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

StatusCode GaudiPython::PyAlgorithm::start

(

)

StatusCode GaudiPython::PyAlgorithm::stop

(

)

StatusCode PyAlgorithm::stop

(

)

Definition at line 94 of file Algorithm.cpp.

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

Member Data Documentation

PyObject * PyAlgorithm::m_self

private

Definition at line 52 of file Algorithm.h.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/include/GaudiPython/Algorithm.h
• GaudiPython/src/Lib/Algorithm.cpp