seCmdCountMon.py

Go to the documentation of this file.

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

__facility__ = "Online"
__abstract__ = "Command Count Monitor class"
__author__   = "S. Tuvi <stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/09/19 10:00:00"
__updated__  = "$Date: 2006/01/26 00:37:56 $"
__version__  = "$Revision: 1.2 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

from LICOS.lib.cmdTlmDb.TelemetryEvent import TelemetryEvent

import threading

class seCmdCountMon(object):
  """!\brief Command Count Monitor class

  """
  def __init__(self, vsc):
    """!\brief seCmdCountMon constructor.

    \param vsc ScriptEngineConnector instance
    """
    self.__vsc = vsc
    # Setup a telemetry handler for the "CmdCnt0" telemetry.
    # We need to keep a command count when the ScriptEngine starts
    # so that when a script runs it knows the starting count and can
    # find out the number of commands executed during the run as reported
    # by the housekeeping telemetry.
    self.__cmdCntTlm  = TelemetryEvent(vsc.getTelemHandler(),
                          [vsc.getTlmDb().getApidFromName('CmdCnt0')],
                          self.__cmdCounter)

    self.__lfsCmdSent  = 0
    self.__limCmdSent  = 0
    self.__lhkCmdSent  = 0
    self.__lcmCmdSent  = 0
    self.__lsmmCmdSent = 0
    self.__lsmsCmdSent = 0

  def __cmdCounter(self, telem):
    """!\brief Callback method for processing the "CmdCnt0" telemetry.

    \param telem Telemetry object
    """
    lcatTlm = self.__vsc.getTlmDb()
    pkt = lcatTlm.decodeTelemetry(telem)
    self.__lfsCmdSent  = pkt.get_payload("LHKLFSCMDSENT")
    self.__limCmdSent  = pkt.get_payload("LHKLIMCMDSENT")
    self.__lhkCmdSent  = pkt.get_payload("LHKLHKCMDSENT")
    self.__lcmCmdSent  = pkt.get_payload("LHKLCMCMDSENT")
    self.__lsmmCmdSent = pkt.get_payload("LHKLSMMCMDSENT")
    self.__lsmscmdSent = pkt.get_payload("LHKLSMSCMDSENT")

  def startMonitor(self):
    """!\brief Enable the "CmdCnt0" telemetry handler.

    """
    self.__cmdCntTlm.enable()

  def stopMonitor(self):
    """!\brief Disable the "CmdCnt0" telemetry handler.

    """
    self.__cmdCntTlm.disable()

  def getLFScmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__lfsCmdSent

  def getLIMcmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__limCmdSent

  def getLHKcmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__lhkCmdSent

  def getLCMcmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__lcmCmdSent

  def getLSMMcmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__lsmmCmdSent

  def getLSMScmdSent(self):
    """!\brief Retrieve the command count for LFS commands.

    \return Command count
    """
    return self.__lsmsCmdSent

  def getAllCmdSent(self):
    """!\brief Retrieve the total command count.

    \return Command count
    """
    return self.__lfsCmdSent  + \
           self.__limCmdSent  + \
           self.__lhkCmdSent  + \
           self.__lcmCmdSent  + \
           self.__lsmmCmdSent + \
           self.__lsmscmdSent

---