rcComplStatus.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__ = "Completion status helper class"
__author__   = "S. Tuvi <Stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/07/23 00:08:27"
__updated__  = "$Date: 2005/09/22 00:29:30 $"
__version__  = "$Revision: 1.4 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

class rcCompletionStatus(object):
  """!\brief Completion code manager class.

  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):
    """!\brief 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):
    """!\brief 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):
    """!\brief 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):
    """!\brief 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):
    """!\brief Return the completion status dictionary

    \return Completion status dictionary.
    """
    return self.__csDict

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

---