In This Package:

DybPythonAlg.py

Go to the documentation of this file.

#!/usr/bin/env python
'''
DayaBay wrapper class for Python-based GaudiAlgorithm

Provides some additional conveniences, like automatic access to the
MessageSvc
'''
# dandwyer@caltech.edu  2009-05-05

__all__ = [ 'DybPythonAlg' ]

# Load GaudiPython
from GaudiPython.GaudiAlgs import GaudiAlgo
from GaudiPython import SUCCESS, FAILURE
from GaudiPython import gbl
from GaudiKernel.Constants import VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL
from GaudiKernel import SystemOfUnits as units
from GaudiPython import iDataSvc
from DybPython.Util import irange
from DybPython.iStatsSvc import iStatsSvc

from GaudiPython import loaddict
loaddict('libHepMCRflx')        # for HepMC Python wrappers

# Base DayaBay Python Algorithm
class DybPythonAlg(GaudiAlgo):
    "Base DayaBay Python Algorithm"
    def __init__(self,name = None):

        '''
        Create a DybPythonAlg.  The name is the class name by default.
        If sub class overrides this method it must be explicitly called like:

        DybPythonAlg.__init__(self,name)
        or
        DybPythonAlg.__init__(self)
        '''

        if not name: name = self.__class__.__name__
        GaudiAlgo.__init__(self,name)
        self.msgSvc = None
        self.archiveSvc = None
        self.stats = iStatsSvc(self)
        return

    def initialize(self):

        '''Initialize the algorithm.  If sub classes overrides this
        method they must call it explicitly near the beginning like:

        sc = DybPythonAlg.initialize(self)
        if sc.isFailure(): return sc
        # ... now do my own initialization ...
        '''

        status = GaudiAlgo.initialize(self)
        if not status.isSuccess(): return status
        # Get handle to message svc
        self.msgSvc = self.svc('IMessageSvc','MessageSvc')
        if self.msgSvc == None:
            print "DybPythonAlg.initialize(): Failed to get MessageSvc"
            return FAILURE
        return SUCCESS

    def _initializeAES(self):
        # Get handle to archive data svc if it is available
        if self.archiveSvc != None:
            self.warning("Archive data service already initialized.")
            return SUCCESS
        archiveSvc = self.svc("IDataProviderSvc","EventDataArchiveSvc")
        if archiveSvc == None:
            self.warning("Archive data service not available.")
            return FAILURE
        else:
            baseSvc = self.svc("IService","EventDataArchiveSvc")
            self.archiveSvc = iDataSvc( baseSvc.name(), archiveSvc )
        return SUCCESS

    def execute(self):
        'Subclass should override this method'
        self.info("Executing DybPythonAlg:"+self.name())
        return SUCCESS
        
    def finalize(self):
        '''Finalize the algorithm.  If sub classes overrides this
        method they must call it explicitly like at the end:

        # ... first do my own finalization ...
        return DybPythonAlg.finalize(self)
        '''
        self.msgSvc.release()
        self.msgSvc = None
        self.archiveSvc = None
        status = GaudiAlgo.finalize(self)
        return status

    # Define some helpful logging shortcuts
    def verbose(self, message):
        'Emit message at verbose level'
        self.msgSvc.reportMessage(self.name(), VERBOSE, message)
        return

    def debug(self, message):
        'Emit message at debug level'
        self.msgSvc.reportMessage(self.name(), DEBUG, message)
        return
    
    def info(self, message):
        'Emit message at info level'
        self.msgSvc.reportMessage(self.name(), INFO, message)
        return
    
    def warning(self, message):
        'Emit message at warning level'
        self.msgSvc.reportMessage(self.name(), WARNING, message)
        return
    
    def error(self, message):
        'Emit message at error level'
        self.msgSvc.reportMessage(self.name(), ERROR, message)
        return
    
    def fatal(self, message):
        'Emit message at fatal level'
        self.msgSvc.reportMessage(self.name(), FATAL, message)
        return
    
    def getAES(self, path):
        'Return the list of items at the AES path'
        if self.archiveSvc == None:
            status = self._initializeAES()
            if (not status.isSuccess()) or self.archiveSvc == None:
                self.error("Archive data svc not available")
                return None
        archiveList = self.archiveSvc[path]
        if archiveList == None:
            self.error("Path in archive not available: "+path)
            return None
        dataList = []
        for dataObject in irange(archiveList.begin(), archiveList.end()):
            dataList.append(dataObject)
        return dataList

---