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


"""TrgAbstract: Interface for Coincidence based Trigger System"""


class TrgAbstract(TrgObject):
  """\brief Abstract trigger interface class definition
  """
  def __init__(self):
    """\brief TrgAbstract constructor
    """
    pass
    
  def conditions(self):
    """\brief conditions 'pure virtual' method

    \return A TrgConditionsValue object
    This object specifies the set of conditions to be enabled when
    the enable() member function is called
    """
    raise NotImplementedError
    pass

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

    \return A TrgEngines object
    This object specifies the set of engines used by the trigger
    """
    raise NotImplementedError
    pass

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

    \return A TrgSequence object
    This object specifies the initial sequence number definitions for the trigger
    """
    raise NotImplementedError
    pass

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

    \return A TrgInputEnables object
    This object specifies the input masking definitions for the trigger
    """
    raise NotImplementedError
    pass

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

    \return An integer
    This value specifies (in a hardware dependent representation) the 
    generation and revision numbers of the Trigger System.
    """
    raise NotImplementedError
    pass

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

    \return An integer
    This value determines the maximum number of Trigger Engines 
    supported by the Trigger System.
    """
    raise NotImplementedError
    pass

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

    \return An integer
    This value specifies the type and number of conditions 
    supported by the Trigger System.
    """
    raise NotImplementedError
    pass

  def solicit(self):
    """\brief Solicit 'pure virtual' method
    
    Allows the application to assert the solicited condition.
    Depending on the engine (or engines) associated with this 
    condition, asserting this condition will most likely cause 
    a readout of the detector. This function returns no value.
    """
    raise NotImplementedError
    pass

  def enable(self):
    """\brief Enable 'pure virtual' method
    
    This function returns no value.
    
    Enables the trigger conditions returned by the conditions() member function. 
    Once a condition is enabled and the 
    condition occurs in the LAT, the Trigger Engines corresponding to 
    the condition will fire and most likely cause a Trigger Message to 
    be emitted by the Trigger System.
    """
    raise NotImplementedError
    pass

  def disable(self):
    """\brief disable 'pure virtual' method
    
    This function returns no value.
    
    Disables the conditions returned by the conditions() member function. 
    Once a condition is disabled, the 
    condition will not activate the Trigger System, independent of its 
    presence in the LAT.
    """
    raise NotImplementedError
    pass

  def shut(self, marker):
    """\brief shut 'pure virtual' method
    
    \param marker an integer representing a marker value
    
    This function returns no value.
    
    This function returns performs two functions:
    a) it disables any enabled conditions
    b) it solicits a trigger with a marker of the value of the input value 
    """
    raise NotImplementedError
    pass

---