NullObjects.py

#!/usr/local/bin/python
#
#                               Copyright 2004
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "GLAST LAT Trigger Tower Interface classes"
__author__   = "Jim Panetta <panetta@slac.stanford.edu> SLAC - GLAST I&T"
__date__     = "2/14/04"
__version__  = "$Revision: 2.3 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC


from TrgTower           import TrgTower
from TrgTower           import TrgCalorimeter
from TrgTower           import TrgTracker

from TrgInputEnables    import TrgInputEnables
from TrgInputEnables    import TrgTowerEnables
from TrgInputEnables    import TrgTileEnables
from TrgInputEnables    import TrgCnoEnables
from TrgInputEnables    import TrgTowerBusyEnables
from TrgInputEnables    import TrgExtEnables

from TrgCoincidences    import TrgRoi
from TrgCoincidences    import TrgCoincidence

from TrgEngines         import TrgEngine
from TrgEngines         import TrgEngineRequest
from TrgEngines         import TrgReadout

"""NullObjects: Interfaces for when there are no objects in the system"""

### Tower system

class NullTower(TrgTower):
  """NullTower class:
     Class defines a tower with no calorimeter active and no tracker active.
  """
  def __init__(self):
    TrgTower.__init__(self)
    self.__cal = NullCal()
    self.__tkr = NullTkr()
  def calorimeter(self):
    return self.__cal
  def tracker(self):
    return self.__tkr

class NullCal(TrgCalorimeter):
  """NullCal class:
     Class defines a calorimeter which is inactive.
     Used by NullTower
  """
  def __init__(self):
    TrgCalorimeter.__init__(self)
  def useHighEnergy(self):
    return False
  def useLowEnergy(self):
    return False

class NullTkr(TrgTracker):
  """NullTkr class:
     Class defines a tracker which is inactive.
     Used by NullTower
  """
  def __init__(self):
    TrgTracker.__init__(self)
  def use(self):
    return False
    
    
###  Input Enables

class NoTowersEnabled(TrgTowerEnables):
  def __init__(self):
    TrgTowerEnables.__init__(self)
    self.__null = NullTower()
  def tower(self,towerNumber):
    return self.__null

class NoTilesEnabled(TrgTileEnables):
  """NoTilesEnabled class:
     Class defining a system where no tiles are enabled.
  """
  def __init__(self):
    TrgTileEnables.__init__(self)
  def tile(self,tileNumber):
    return 0

class NoCnoEnabled(TrgCnoEnables):
  """NoCnoEnabled class:
  Class defining a system where all CNO inputs are disabled.
  """
  def __init__(self):
    TrgCnoEnables.__init__(self)
    #Do nothing else.  Default is all disabled.

class NoTowersBusy(TrgTowerBusyEnables):
  """NoTowersBusy class:
     Class defining a system where no tower busy bits are enabled.
  """
  def __init__(self):
    TrgTowerBusyEnables.__init__(self)
  def tower(self, towerNumber):
    return False

class NoExternal(TrgExtEnables):
  """NoExternal class:
     Class defining a system where no trigger is enabled.
  """
  def __init__(self):
    TrgExtEnables.__init__(self)
  def external(self):
    return False

class NoInputsEnabled(TrgInputEnables):
  """NoInputsEnabled class:
  Class defining a system where no inputs are enabled.
  """
  def __init__(self):
    TrgInputEnables.__init__(self)
    self.__towers  = NoTowersEnabled()
    self.__tiles   = NoTilesEnabled()
    self.__cno     = NoCnoEnabled()
    self.__twrBusy = NoTowersBusy()
    self.__ext     = NoExternal()
    
  def towers(self):     return self.__towers
  def tiles(self):      return self.__tiles
  def cno(self):        return self.__cno
  def towerBusy(self):  return self.__twrBusy
  def external(self):   return self.__ext
  
### Coincidence system

class NullRoi(TrgRoi):
  """NullRoi class:
     Class defining a system where the ROI contains no tiles.
  """
  def __init__(self):
    TrgRoi.__init__(self)
  def tile(self, tileNumber):
    return False
    
class NullCoincidence(TrgCoincidence):
  """NullCoincidence class:
  Class defining a coincidence set that is all null.
  """
  def __init__(self):
    TrgCoincidence.__init__(self)
      
  def inCoincidence(self,tileNumber):
    return -1  # Tile not in coincidence List

# TrgEngines

class NullEngine(TrgEngine):
  """NullEngine class:
  This class defines an engine doesn't do anything.
  Prescale is set to -1 to prevent engine from firing.
  """
  def __init__(self):
    TrgEngine.__init__(self)
    self.__request = NullRequest()
  def participate(self,conditionsValue):
    return False
  def prescale(self):
    return -1
  def request(self):
    return self.__request

class NullRequest(TrgEngineRequest):
  """NullRequest class:
     This class defines an engineRequest that doesn't do anything
     However sequence must be set, so the detector will be read out.
  """
  def __init__(self):
    """\brief constructor
    """
    TrgEngineRequest.__init__(self)
  def sequence(self):
    return 2

---