TrgGemAbstract.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.3 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

"""TrgGemAbstract: Abstract interface for GEM based systems. """

from TrgObject   import TrgObject
from TrgAbstract import TrgAbstract
from TrgPeriodic import TrgPeriodicCondition

class TrgGemAbstract(TrgAbstract):
  """\brief Trigger Global trigger Electronics Module Interface class definition
  """
  def __init__(self):
    """\brief TrgGemAbstract constructor
    """
    TrgAbstract.__init__(self)


  #############  Pure Virtual functions
  def width(self):
    """\brief width 'pure virtual' method

    \return An int.

    This value specifies the window of the GEM's trigger window
    (see [4]). The width is specified in units of system clock, where one
    system clock is 50 nanoseconds.
    """
    raise NotImplementedError
    pass

  def useAcdAsTrigger(self):
    """\brief UseAcdAsTrigger 'pure virtual' method

    \return A boolean

    This value specifies whether or not the the ROI generator and its ACD
    tile signals are be used as a trigger or as a veto.
    If the value returned is TRUE, the ROI generator is used as a trigger.
    If the value returned is FALSE, the ROI generator is used as a veto.
    """
    raise NotImplementedError
    pass

  def redundantPPS(self):
    """\brief RedundantPPS 'pure virtual' method

    \return A boolean

    This value specifies whether or not the GEM should use the redundant
    1-PPS signal. If the value returned is TRUE, the redundant 1-PPS signal
    will be used. If the value returned is FALSE, the primary
    1-PPS signal will not be used.
    """
    raise NotImplementedError
    pass

  def responseHeaderParityEven(self):
    """\brief responseHeaderParityEven 'pure virtual' method

    \return A boolean

    This value specifies whether or not the parity associated with a command
    responsepacket header should be sent with odd or even parity. If the value returned is
    TRUE, response headers will have even parity. If the value returned is FALSE,
    responses will have odd parity.
    """
    raise NotImplementedError
    pass

  def responseDataParityEven(self):
    """\brief responseDataParityEven 'pure virtual' method

    \return A boolean

    This value specifies whether or not the parity associated with a command
    response packet body should be sent with odd or even parity. If the value returned is
    TRUE, response bodies will have even parity. If the value returned is FALSE,
    responses will have odd parity.
    """
    raise NotImplementedError
    pass

  def eventHeaderParityEven(self):
    """\brief eventHeaderParityEven 'pure virtual' method

    \return A boolean

    This value specifies whether or not the parity associated with a trigger
    message header initiated by the GEM should be sent with odd or even parity.
    If the value returned is TRUE, trigger message headers will have even parity.
    If the value returned is FALSE, trigger message headers will have odd parity.
    """
    raise NotImplementedError
    pass

  def eventDataParityEven(self):
    """\brief eventDataParityEven 'pure virtual' method

    \return A boolean

    This value specifies whether or not the parity associated with a trigger
    message body initiated by the GEM should be sent with odd or even parity.
    If the value returned is TRUE, trigger message bodies will have even parity.
    If the value returned is FALSE, trigger message bodies will have odd parity.
    """
    raise NotImplementedError
    pass

  def triggerParityEven(self):
    """\brief TriggerParityEven 'pure virtual' method

    \return A boolean

    This value specifies whether or not the parity associated with a trigger
    message initiated by the GEM should be sent with odd or even parity.
    If the value returned is TRUE, trigger messages will have even parity.
    If the value returned is FALSE, trigger messages will have odd parity.
    """
    raise NotImplementedError
    pass

  def inhibitContribution(self):
    """\brief inhibitContribution 'pure virtual' method

    \return A boolean

    This value specifies whether or not the GEM transmits a contribution
    to the event.
    If the value returned is TRUE, GEM contributions are inhibited.
    If the value returned is FALSE, GEM contributions are sent with the event.
    """
    raise NotImplementedError
    pass

  def periodicCondition(self):
    """\brief PeriodicCondition 'pure virtual' method

    \return A TrgPeriodicCondition object

    This object specifies the initial and current definition of
    the periodic condition
    """
    raise NotImplementedError
    pass

  def roi(self):
    """\brief Roi 'pure virtual' method

    \return A TrgRoi object

    This object specifies the definition of the GEM's ROI generator
    """
    raise NotImplementedError
    pass

  def triggerCounters(self):
    """\brief triggerCounters 'pure virtual' method

    \return A TrgTriggerCounters object

    This object specifies an implementation of the GEM's trigger counters
    """
    raise NotImplementedError
    pass

  def cnoCounters(self):
    """\brief cnoCounters 'pure virtual' method

    \return A TrgCnoCounters object

    This object specifies an implementation of the GEM's cno counters
    """
    raise NotImplementedError
    pass

  def tileCounters(self):
    """\brief tileCounters 'pure virtual' method

    \return A TrgTileCounters object

    This object specifies an implementation of the GEM's tile counters
    """
    raise NotImplementedError
    pass

  def cmdCounters(self):
    """\brief cmdCounters 'pure virtual' method

    \return A TrgCmdCounters object

    This object specifies an implementation of the GEM's Command/Response counters
    """
    raise NotImplementedError
    pass

  def eventCounter(self):
    """\brief eventCounter 'pure virtual' method

    \return A TrgEventCounter object

    This object specifies an implementation of the GEM's events sent counter
    """
    raise NotImplementedError
    pass

  def ppsTimer(self):
    """\brief ppsTimer 'pure virtual' method

    \return A TrgPPSTimer object

    This object specifies an implementation of the GEM's 1-PPS timer
    """
    raise NotImplementedError
    pass


  ############### Pure virtual function implementation
  def maxEngines(self):
    return (TrgObject.ENGINE_NUMBER_MAX + 1)

  def maxConditions(self):
    return (TrgObject.CONDITIONS_NUMBER_MAX + 1)

---