rcRunIdHelper.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__ = "Utility class to set and retrieve run id"
__author__   = "S. Tuvi <stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/07/23 00:08:27"
__updated__  = "$Date: 2006/01/28 05:39:49 $"
__version__  = "$Revision: 1.6 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

from ConfigParser import *
import os

class rcRunIdHelper(object):
  """!\brief Utility class to set and retrieve run id.

  """
  SECTION_M = 'MachineData'
  SECTION_R = 'RunIdData'
  OPTION_MID = 'machineid'
  OPTION_RID = 'runid'

  def __init__(self, prefs):
    """!\brief rcRunIdHelper constructor.

    \param prefs Preferences instance.
    """
    self.__parser = ConfigParser()

    if 'runiddir' in prefs:
      self.configFile = os.path.join(prefs['runiddir'], 'runId.cfg')
    else:
      raise RuntimeError, "Preference file doesn't specify runId location"

    if os.path.exists(self.configFile):
      self.__parser.read(self.configFile)
    else:
      errorMsg = self.configFile + " not found. "
      errorMsg += "Did you forget to copy it from a previous installation or from runId.cfg.sample?"
      raise RuntimeError, errorMsg

  def currentRunId(self):
    """!\brief Retrieve the current run id.

    \return The current run id (includes the machine id).
    """
    rid = -1
    mid = -1
    try:
      mid = int(self.__parser.get(self.SECTION_M, self.OPTION_MID))
      rid = int(self.__parser.get(self.SECTION_R, self.OPTION_RID))
    except:
      pass

    if mid == -1 or rid == -1:
      return '-1'
    else:
      return ('%03d%06d' % (mid, rid))

  def nextRunId(self):
    """!\brief Increment the run id and update runId.cfg.

    \return The next run id.
    """
    self.__parser.read(self.configFile)
    
    rid = -1
    mid = -1
    try:
      mid = int(self.__parser.get(self.SECTION_M, self.OPTION_MID))
      rid = int(self.__parser.get(self.SECTION_R, self.OPTION_RID))
    except:
      pass

    if mid == -1 or rid == -1:
      return '-1'
    else:
      if mid == 0:
        errorMsg = self.configFile + " has an invalid machine id. "
        errorMsg += "Please choose a valid and unique id for your subsystem and this teststand "
        errorMsg += "and enter it in this file (See runId.cfg.sample file in the same directory for "
        errorMsg += "subsystem allocation of machine ids)."
        raise RuntimeError, errorMsg
      else:
        rid +=1
        self.__parser.set(self.SECTION_R, self.OPTION_RID, str(rid))
        self.__parser.write(file(self.configFile, "w+"))
        return ('%03d%06d' % (mid, rid))

---