Inheritance diagram for python.PyAthenaComps.Alg:

Collaboration diagram for python.PyAthenaComps.Alg:

Public Member Functions
	__init__ (self, name=None, **kw)
	evtStore (self)
	detStore (self)
	condStore (self)
	sysInitialize (self)
	initialize (self)
	sysReinitialize (self)
	reinitialize (self)
	sysExecute (self, cppcontext)
	execute (self)
	sysFinalize (self)
	finalize (self)
	sysStart (self)
	start (self)
	sysStop (self)
	stop (self)
	filterPassed (self)
	setFilterPassed (self, state)
	resetExecuted (self)
	setExecuted (self, state)
	isExecuted (self)
	getContext (self)

Public Attributes
	name = name
	OutputLevel

Protected Attributes
	_pyath_evtstore = None
	init base class
	_pyath_detstore = None
	_pyath_condstore = None
	_ctx = None

Private Attributes
str	__component_type__ = "Algorithm"

Detailed Description

Base class from which all concrete algorithm classes should
be derived.

In order for a concrete algorithm class to do anything
useful the methods initialize(), execute() and finalize()
should be overridden.

Definition at line 62 of file PyAthenaComps.py.

Constructor & Destructor Documentation

◆ init()

python.PyAthenaComps.Alg.__init__	(		self,
			name = None,
		**	kw )

Definition at line 71 of file PyAthenaComps.py.

    def __init__(self, name = None, **kw):
        if name is None: name = kw.get('name', self.__class__.__name__)
        kw.setdefault('OutputLevel', 3) #INFO
        
        super(Alg, self).__init__(name, **kw)
        self._pyath_evtstore = None # handle to the evt store
        self._pyath_detstore = None # handle to the det store
        self._pyath_condstore = None # handle to the cond store
        self._ctx = None
        self.__component_type__="Algorithm"
        self.name=name
        return
 

Member Function Documentation

◆ condStore()

python.PyAthenaComps.Alg.condStore ( self )

Definition at line 99 of file PyAthenaComps.py.

    def condStore(self):
        if not self._pyath_condstore:
            import AthenaPython.PyAthena as PyAthena
            self._pyath_condstore = PyAthena.py_svc('StoreGateSvc/ConditionStore')
        return self._pyath_condstore
    

◆ detStore()

python.PyAthenaComps.Alg.detStore ( self )

Definition at line 92 of file PyAthenaComps.py.

    def detStore(self):
        if not self._pyath_detstore:
            import AthenaPython.PyAthena as PyAthena
            self._pyath_detstore = PyAthena.py_svc('StoreGateSvc/DetectorStore')
        return self._pyath_detstore
    

◆ evtStore()

python.PyAthenaComps.Alg.evtStore ( self )

Definition at line 85 of file PyAthenaComps.py.

    def evtStore(self):
        if not self._pyath_evtstore:
            import AthenaPython.PyAthena as PyAthena
            self._pyath_evtstore = PyAthena.py_svc('StoreGateSvc/StoreGateSvc')
        return self._pyath_evtstore
    

◆ execute()

python.PyAthenaComps.Alg.execute ( self )

Definition at line 134 of file PyAthenaComps.py.

    def execute(self):
        return StatusCode.Success
 

◆ filterPassed()

python.PyAthenaComps.Alg.filterPassed ( self )

Did this algorithm pass or fail its filter criterion for the last event?

Definition at line 155 of file PyAthenaComps.py.

    def filterPassed(self):
        """Did this algorithm pass or fail its filter criterion for the last event?"""
        return self._cppHandle.filterPassed()
 

◆ finalize()

python.PyAthenaComps.Alg.finalize ( self )

Definition at line 140 of file PyAthenaComps.py.

    def finalize(self):
        return StatusCode.Success
 

◆ getContext()

python.PyAthenaComps.Alg.getContext ( self )

Definition at line 173 of file PyAthenaComps.py.

    def getContext(self):
       return self._ctx
    

◆ initialize()

python.PyAthenaComps.Alg.initialize ( self )

Definition at line 112 of file PyAthenaComps.py.

    def initialize(self):
        return StatusCode.Success
 

◆ isExecuted()

python.PyAthenaComps.Alg.isExecuted ( self )

Definition at line 170 of file PyAthenaComps.py.

    def isExecuted(self):
       return self._cppHandle.isExecuted()
 

◆ reinitialize()

python.PyAthenaComps.Alg.reinitialize ( self )

Definition at line 122 of file PyAthenaComps.py.

    def reinitialize(self):
        return StatusCode.Success
 

◆ resetExecuted()

python.PyAthenaComps.Alg.resetExecuted ( self )

Definition at line 163 of file PyAthenaComps.py.

    def resetExecuted(self):
       self.setExecuted(False)
       return StatusCode.Success
    

◆ setExecuted()

python.PyAthenaComps.Alg.setExecuted	(		self,
			state )

Definition at line 167 of file PyAthenaComps.py.

    def setExecuted(self,state):
       return self._cppHandle.setExecuted(state)
    

◆ setFilterPassed()

python.PyAthenaComps.Alg.setFilterPassed	(		self,
			state )

Set the filter passed flag to the specified state

Reimplemented in python.PyAthenaComps.AthFilterAlgorithm.

Definition at line 159 of file PyAthenaComps.py.

    def setFilterPassed(self, state):
        """Set the filter passed flag to the specified state"""
        return self._cppHandle.setFilterPassed(state)
    

◆ start()

python.PyAthenaComps.Alg.start ( self )

Definition at line 146 of file PyAthenaComps.py.

    def start(self):
        return StatusCode.Success
 

◆ stop()

python.PyAthenaComps.Alg.stop ( self )

Definition at line 152 of file PyAthenaComps.py.

    def stop(self):
        return StatusCode.Success
 

◆ sysExecute()

python.PyAthenaComps.Alg.sysExecute	(		self,
			cppcontext )

Definition at line 125 of file PyAthenaComps.py.

    def sysExecute(self, cppcontext):
        import cppyy
        self._ctx = cppyy.bind_object(cppcontext, "EventContext")
        try:
            ret = self.execute()
        finally:
            self._ctx = None
        return ret
    

◆ sysFinalize()

python.PyAthenaComps.Alg.sysFinalize ( self )

Definition at line 137 of file PyAthenaComps.py.

    def sysFinalize(self):
        return self.finalize()
    

◆ sysInitialize()

python.PyAthenaComps.Alg.sysInitialize ( self )

Reimplemented in python.PyAthenaComps.AthFilterAlgorithm.

Definition at line 105 of file PyAthenaComps.py.

    def sysInitialize(self):
        if hasattr(self, 'OutputLevel'):
            self.msg.setLevel(self.OutputLevel)
        else:
            self.msg.setLevel(_get_prop_value(self,'OutputLevel'))
        return self.initialize()
    

◆ sysReinitialize()

python.PyAthenaComps.Alg.sysReinitialize ( self )

Definition at line 115 of file PyAthenaComps.py.

    def sysReinitialize(self):
        if hasattr(self, 'OutputLevel'):
            self.msg.setLevel(self.OutputLevel)
        else:
            self.msg.setLevel(_get_prop_value(self,'OutputLevel'))
        return self.reinitialize()
    

◆ sysStart()

python.PyAthenaComps.Alg.sysStart ( self )

Definition at line 143 of file PyAthenaComps.py.

    def sysStart(self):
        return self.start()
    

◆ sysStop()

python.PyAthenaComps.Alg.sysStop ( self )

Definition at line 149 of file PyAthenaComps.py.

    def sysStop(self):
        return self.stop()
    

Member Data Documentation

◆ __component_type__

str python.PyAthenaComps.Alg.__component_type__ = "Algorithm"

private

Definition at line 80 of file PyAthenaComps.py.

◆ _ctx

python.PyAthenaComps.Alg._ctx = None

protected

Definition at line 79 of file PyAthenaComps.py.

◆ _pyath_condstore

python.PyAthenaComps.Alg._pyath_condstore = None

protected

Definition at line 78 of file PyAthenaComps.py.

◆ _pyath_detstore

python.PyAthenaComps.Alg._pyath_detstore = None

protected

Definition at line 77 of file PyAthenaComps.py.

◆ _pyath_evtstore

python.PyAthenaComps.Alg._pyath_evtstore = None

protected

init base class

Definition at line 76 of file PyAthenaComps.py.

◆ name

python.PyAthenaComps.Alg.name = name

Definition at line 81 of file PyAthenaComps.py.

◆ OutputLevel

python.PyAthenaComps.Alg.OutputLevel

Definition at line 107 of file PyAthenaComps.py.

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

PyAthenaComps.py

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ condStore()

◆ detStore()

◆ evtStore()

◆ execute()

◆ filterPassed()

◆ finalize()

◆ getContext()

◆ initialize()

◆ isExecuted()

◆ reinitialize()

◆ resetExecuted()

◆ setExecuted()

◆ setFilterPassed()

◆ start()

◆ stop()

◆ sysExecute()

◆ sysFinalize()

◆ sysInitialize()

◆ sysReinitialize()

◆ sysStart()

◆ sysStop()

Member Data Documentation

◆ __component_type__

◆ _ctx

◆ _pyath_condstore

◆ _pyath_detstore

◆ _pyath_evtstore

◆ name

◆ OutputLevel

◆ init()