TrgMiniGLTAbstract.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 Interface 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

"""TrgMiniGLTAbstract: Abstract interface for MiniGLT based systems. """

from TrgAbstract import TrgAbstract

class TrgMiniGLTAbstract(TrgAbstract):
  """\brief TrgMiniGLTAbstract Interface class definition
  This class inherits from TrgAbstract to define the structure of
  a MiniGLT trigger.  
  """
  def __init__(self):
    """\brief TrgMiniGLTAbstract constructor
    """
    TrgAbstract.__init__(self)

  #############  Pure Virtual functions
  def parity(self):
    """\brief parity() member function
    Returns a boolean indicating the state of the parity bitfield
    in the configuration register of the MiniGLT
    \return a boolean
    """
    raise NotImplementedError
    pass

  def tag(self):
    """\brief tag() member function
    Returns an integer indicating the state of the tag bitfield in 
    the configuration register of the MiniGLT
    \return an integer
    """
    raise NotImplementedError
    pass

  def eventNumber(self):
    """\brief eventNumber() member function
    Returns an integer indicating the starting event number
    of the MiniGLT
    \return an integer
    """
    raise NotImplementedError
    pass

  def destination(self):
    """\brief destination() member function
    Returns an integer indicating the state of the destination bitfield in 
    the configuration register of the MiniGLT
    \return an integer
    """
    raise NotImplementedError
    pass

  def marker(self):
    """\brief marker() member function
    Returns an integer indicating the state of the marker bitfield in 
    the configuration register of the MiniGLT
    \return an integer
    """
    raise NotImplementedError
    pass

  def tack(self):
    """\brief tack() member function
    Returns a boolean indicating the state of the tack bitfield
    in the configuration register of the MiniGLT
    \return a boolean
    """
    raise NotImplementedError
    pass

  def zeroSuppress(self):
    """\brief zeroSuppress() member function
    Returns a boolean indicating the state of the zeroSuppress bitfield
    in the configuration register of the MiniGLT
    \return a boolean
    """
    raise NotImplementedError
    pass

  def fourRangeReadout(self):
    """\brief fourRangeReadout() member function
    Returns a boolean indicating the state of the fourRangeReadout bitfield
    in the configuration register of the MiniGLT
    \return a boolean
    """
    raise NotImplementedError
    pass

  def calStrobe(self):
    """\brief calStrobe() member function
    Returns a boolean indicating the state of the calStrobe bitfield
    in the configuration register of the MiniGLT
    \return a boolean
    """
    raise NotImplementedError
    pass

---