rcComplStatus.py

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

__facility__ = "Online"
__abstract__ = "Completion status helper class"
__author__   = "S. Tuvi <Stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = ("$Date: 2004/11/24 01:07:47 $").split(' ')[1]
__version__  = "$Revision: 2.5 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

class rcCompletionStatus(object):
  """This helper class provides methods to facilitate the management
  of completion codes.
  """
  __csDict = {
                     0: 'PASSED',
                    -1: 'UNDEFINED',
                    -2: 'ABORTED',
                    -3: 'FAILED',
                    -4: 'PASSED CONDITIONALLY',
                    -5: 'MARGINAL',
                    -6: 'OPERATOR ABORTED',
                    -7: 'INCOMPLETE',
                  }

  def getCompletionStatus(statStr):
    """Return the completion status code based
    on the description.

    \param statStr Completion status description

    \return Completion status code or None if it doesn't exist.
    """
    for (status, statusStr) in rcCompletionStatus.__csDict.items():
      if statusStr == statStr:
        return status
  getCompletionStatus = staticmethod(getCompletionStatus)

  def getCompletionStatusStr(self, status):
    """Return the completion status string based
    on the code.

    \param status Completion status code

    \return Completion status description or None if it doesn't exist.
    """
    if status in self.__csDict:
      return self.__csDict[status]

  def isCompletionStatus(self, status):
    """Check if \a status is already in the dictionary.

    \param status Completion status code

    \return True : If it is already defined.
            False: Otherwise
    """
    return (status in self.__csDict)

  def addCompletionStatus(self, status, statusStr):
    """Adds the new completion status code and its
    description to the dictionary.

    \param status    Completion status code
    \param statusStr Completion status description

    \return  0: If add is successful.
            -1: If status code already exists.
            -2: If a duplicate description was found.
    """
    if self.getCompletionStatus(statusStr) is not None:
      # Duplicate description
      return -2
    if status not in self.__csDict:
      self.__csDict[status] = statusStr
      # Status added successfully
      return 0
    else:
      # Already exists
      return -1

  def getAll(self):
    return self.__csDict

#-------------------------------------------------------------------------------

---