testSAppCal_Lean.py

#!/usr/local/bin/python
#
#                               Copyright 2002
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "Example CAL test application"
__author__   = "R. Claus <Claus@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "11/21/2002"
__version__  = "$Revision: 1.1 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

import threading
import logging       as     log
from   LATTE.runcontrol.rcTransitions import rcTransitions
from   LATTE.runcontrol.ArgumentImpl  import ArgumentImpl
import time

from support.SimpleGasuExample   import *
from support.MiniGLTExample      import *

#  This class puts up a GUI for inputting a value of some sort.  It is used by
#  the userApplication example to get the number of self triggers to take.
class userArgument(ArgumentImpl):
  "GUI for getting the user to input some sort of value."
  def __init__(self, parent = None, name = None, modal = 0, fl = 0):
    ArgumentImpl.__init__(self, parent, name, modal, fl)
    self.__value = 0
    self.setCaption("Hello world!")

  def OKButtonClicked(self):
    self.__value = int(self.ArgumentList.text().latin1())
    self.close()

  def CancelButtonClicked(self):
    self.__value = None
    self.close()

  def getValue(self, caption):
    self.setCaption(caption)
    self.show()
    self.exec_loop()
    return self.__value

class userArgText(object):
  "Text user interface for getting the user to input some sort of value"
  def __init__(self):
    pass

  def getValue(self, caption):
    return int(raw_input("%s: " % (caption)))


#  Example application implementation.
#  Note that the name of the class must be userApplication.
#  Look at rcTransitions for names of other transition methods that can be used.
class userApplication(rcTransitions):
  "Implementation class for a user application"
  SWEEP_MARKER     = 5   
  
  def __init__(self, rc, userId, debug):
    rcTransitions.__init__(self, rc, userId, debug)
    log.debug("userApplication.__init__()")
    self.__eventSem    = threading.Semaphore(0)
    self.__cmdSynchSem = threading.Semaphore(0)

  def getName(self):
    return __name__

  def setup(self):
    log.debug("userApplication.setup()")

    if self.isRunFromSuite():
      self.__arg = None
    elif self.rc is None:
      self.__arg = userArgText()
    else:
      self.__arg = self.rc.createGUI(userArgument, self.rc, 'test1', 1)

    # Get a TEM instance
    if self.lat.TEMcnt() == 1:
      tem = self.lat.TEM[self.lat.TEM.keys()[0]]
    elif self.lat.TEMcnt() > 1:
      tem = self.lat.TEM.all()
    else:
      log.fatal("No TEM(s) found in the schema")
      return -1

    # clear TEM stats reg
    tem.COMMAND_RESPONSE = 0

    # clear TEM status reg
    tem.STATUS = 0

    ccc2 = tem.downCCC(2) # O$GCCC_02
    ccc2.LAYER_MASK_1 = 0x3BFD3FFFL

    # Two choices for the trigger, GEM and MiniGLT
    if self.lat.existsGEM():
      self.trigger( SimpleGasuExample() )
    else:
      self.trigger( MiniGLTExample() )
    
    self.selectEventHandler(rcTransitions.EVENT_HANDLER_LEAN_AND_MEAN)

    # A state transition can be rejected by not returning None
    return None

  def startRun(self):
    log.debug("userApplication.startRun()")

    if self.isRunFromSuite():
      cnt = self.getSessionVar("eventCount")
      if cnt is None:
        log.error("Event count is not passed from the suite")
        return -1
    else:
      caption = "Enter number of triggers to take"
      if self.rc is None:
        cnt = self.__arg.getValue(caption)
      else:
        cnt = self.rc.execGUImethod(self.__arg.getValue, caption)

    # The user pressed 'Cancel'
    if cnt is None:  return -1
    self.__cnt = cnt

    # Spawn a thread to synchronize commands with events
    self.__cmdSynchQuit = False

    # A state transition can be rejected by not returning None
    return None

  def stopRun(self):
    log.debug("userApplication.stopRun()")

    if self.getBadEvents() == 0 and self.getErrorEvents() == 0:
      self.setCompletionStatus(self.COMPL_STATUS_PASSED)
    else:
      self.setCompletionStatus(self.COMPL_STATUS_FAILED)

    self.setSessionVar("completionStatus", self.getCompletionStatus())

    if self.getSessionVar("test") is not None:
      self.setSessionVar("test", self.getSessionVar("test") + "d")

    self.__cmdSynchQuit = True
    self.__eventSem.release()
    #self.__cmdSynch.join()

    # The STOP_RUN transition can not be rejected

  def resume(self):
    log.debug("userApplication.resume()")

    # Issue self trigger to make up for the one that was lost during PAUSE
    self.trigger().solicit()

    return None

  def stop(self):
    log.debug("userApplication.stop()")

    return self.stopRun()

  def teardown(self):
    log.debug("userApplication.teardown()")
    # Allow the C++ object to be deleted
    if self.rc is not None and self.__arg is not None:
      self.__arg.deleteLater()

  def process(self, (status, buffer)):
    "Method called back for each data event taken"
    ##log.debug("userApplication.process()")

    evtCli = self.evtCli

    if status != 0:
      self.__eventSem.release()
      return
    try:
      # In the future this event may contain additional data
      if self.eventMarker == self.SWEEP_MARKER: return
    except:
      # Event summary word inaccessible, handle the bad event here
      log.exception("")
      return

    # Get next event triggered
    self.__eventSem.release()

  #def __commandSynch(self, count):
  def commandSynch(self):
    "Method called by the command synchronization task"
    import time
    trigger  = self.trigger()
    eventSem = self.__eventSem
    # Drain the semaphore release count
    # Handles the case when the stop run release collided with a trigger release
    while eventSem.acquire(0):  pass

    t0  = time.time()

    # Compensate for the extra CMD_SELF_TRIGGER below
    cnt = 1
    count = self.__cnt

    # Wait for START_RUN to enable triggers
    trigger.waitForMaskEnable()

    trigger.solicit()                   # Issue an internal trigger
    eventSem.acquire()                  # Wait for the event to be processed

    t1 = trigger.getEnableTime()        # get the last trigger enable time from GLT

    while cnt < count and not self.__cmdSynchQuit:
      cnt += 1
      trigger.solicit()                 # Issue an internal trigger
      time.sleep(.0001)
      eventSem.acquire()                # Wait for the event to be processed
      #trigger.disable()                # Disable triggers
      # Do stuff
      #trigger.enable()                 # Enable triggers

    t2 = trigger.getTimeStamp()         # Get the last trigger timestamp
    # When we get here the triggers should still be enabled.
    # If the glt.MASK needs to be set through any other means
    # then it needs to be restored to its SETUP value here.

    if t1 is None:
      t1 = t0
    if t2 is None:
      t2 = time.time()
    dT = t2 - t1
    if dT == 0.0:  dT = 0.000001
    log.info("%s processed %d events in %.3f seconds = %.1f events/second" % \
             (self.getName(), self.evtCnt, dT, self.evtCnt/dT))

    # Get out of waiting when in batch or standalone mode
    self.sync()

    # execute the GUI functions for stopRun, just in case
    if not self.__cmdSynchQuit and not self.isRunFromSuite():
      if self.rc is not None:
        self.rc.doStop()

  def wait(self):
    self.__cmdSynchSem.acquire()

  def sync(self):
    if __name__ == "__main__" or self.isRunFromSuite():
      self.__cmdSynchSem.release()


# Standalone mode:
if __name__ == "__main__":
  from LATTE.runcontrol.RunControlCommon import RunControlCommon

  rcCommon = RunControlCommon()
  rcCommon.initialize()
  rcCommon.setLoggingLevel("INFO")
  rcCommon.connect()
  ua = userApplication(None, 321, rcCommon)
  ua.rcSetup()
  ua.rcStartRun()
  ua.wait()
  ua.rcStopRun()
  ua.rcTeardown()

---