TrgTileCounters.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 Coincidence based Trigger System Abstract classes"
__author__   = "Jim Panetta <panetta@slac.stanford.edu> SLAC - GLAST I&T"
__date__     = "2/14/04"
__version__  = "$Revision: 2.1 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC


from TrgObject import TrgObject


"""TrgTileCounters: Trigger GEM tile counter abstract class"""

class TrgTileCounters(TrgObject):
  """\brief TrgTileCounters class definition
  This class controls the counters used to count ACD tile transitions.
  """
  def __init__(self): # constructor...
    pass
    
  def stats(self):
    """\brief stats() member function
    Returns the statistics object for the tile counters
    \return A TrgTileStats object
    """
    raise NotImplementedError
    pass # returns a TrgTileStats object...

  def reset(self):
    """\brief reset() member function
    Reset the tile statistics
    """
    raise NotImplementedError
    pass # returns void...
  
  def assignA(self, a):
    """\brief assignA() member function
    Assign the 'A' tile counter to watch a particular tile
    Immediately after counter assignment, both counters are reset.
    """
    raise NotImplementedError
    pass # returns void...

  def assignB(self, B):
    """\brief assignB() member function
    Assign the 'B' tile counter to watch a particular tile
    Immediately after counter assignment, both counters are reset.
    """
    raise NotImplementedError
    pass # returns void...

  def assignAB(self, a, b):
    """\brief assignAB() member function
    Assign both the 'A' and the'B' tile counters to watch two tiles
    Immediately after counter assignment, both counters are reset.
    """
    raise NotImplementedError
    pass # returns void...


class TrgTileStats(TrgObject):
  """\brief TrgTileStats class definition
  This class specifies the statistics returned by the counters 
  described by TrgTileCounters.
  """
  def __init__(self): # constructor...
    pass
    
  def A(self):
    """
    Return the statistics for the 'A' tile counter
    \return an integer
    """
    raise NotImplementedError
    pass # returns an integer...
    
  def B(self):
    """
    Return the statistics for the 'B' tile counter
    \return an integer
    """
    raise NotImplementedError
    pass 

---