TrgSequence.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 Trigger Sequence 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


from TrgObject import TrgObject


"""TrgSequence: Interface for Trigger Sequences"""


class TrgSequenceAbstract(TrgObject):
  """\brief Abstract Trigger Sequence class definition
  """
  def __init__(self):
    """\brief TrgSequenceAbstract constructor
    """
    pass

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

    \return An integer containing the current event number
    """
    raise NotImplementedError
    pass

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

    \return An integer containing the current event tag value
    """
    raise NotImplementedError
    pass

class TrgSequenceDefinition(TrgSequenceAbstract):
  """\brief Trigger Sequence Definition class definition
  """
  def __init__(self): # constructor...
    """\brief TrgSequenceDefinition constructor
    """
    TrgSequenceAbstract.__init__(self)
    
    
class TrgSequence(TrgSequenceAbstract):
  """\brief Trigger Sequence class definition
  """
  def __init__(self): # constructor...
    """\brief TrgSequence constructor
    """
    TrgSequenceAbstract.__init__(self)
    
  def definition(self) :
    """\brief definition() member
    \return an object of type TrgSequenceDefinition
    """
    pass # returns an object of type TrgSequenceDefinition


class TrgDefaultSequence(TrgSequenceDefinition):
  """The class defines 'sensible' values for the initial Event and Tag numbers. 
  """
  def __init__(self): 
    """\brief TrgDefaultSequence constructor
    """
    TrgSequenceAbstract.__init__(self)
    
  def eventNumber(self):
    """\brief eventNumber() method
    Returns 0
    """
    return 0x0
    
  def eventTag(self):
    """brief eventTag() method
    Returns 0
    """
    return 0x0
    

---