TrgTriggerCounters.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


"""TrgTriggerCounters: Abstract interface to trigger counters"""


class TrgTriggerCounters(TrgObject):
  """\brief TrgTriggerCounters class definition
  This class controls the counters associated with the performance of 
  the LAT with respect to the Trigger System.
  """
  def __init__(self):
    """\brief TrgTriggerCounters constructor
    """
    pass

  def stats(self):
    """ \brief stats() method
    Returns the Trigger Counter Statistics object.
    \return A TrgTriggerStats object
    """
    raise NotImplementedError
    pass
    
  def reset(self):
    """\brief reset() method
    Reset the trigger counters.
    """
    raise NotImplementedError
    pass

class TrgTriggerStats(TrgObject):
  """\brief TrgTriggerStats
  This class specifies the statistics returned by the counters defined in TrgTriggerCounters.
  """
  def __init__(self): # constructor...
    """\brief TrgTriggerStats constructor
    """
    pass
  def livetime(self):
    """ \brief livetime() method
    Return the system livetime
    \return an integer
    """
    raise NotImplementedError
    pass # returns an integer...
    
  def prescaled(self):
    """ \brief prescaled() method
    Return the number of events that have been prescaled
    \return an integer    """
    raise NotImplementedError
    pass # returns an integer...
    
  def discarded(self):
    """\brief discarded() method
    Return the number of events discarded
    \return an integer
    """
    raise NotImplementedError
    pass # returns an integer...
    
  def sent(self):
    """\brief sent() method
    Return the number of events sent on
    \return an integer
    """
    raise NotImplementedError
    pass # returns an integer...

---