rcParamVerifier.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__ = "Parameter verifier class"
__author__   = "S. Tuvi <STuvi@SLAC.Stanford.edu>"
__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

from rcParamVerifyGUIImpl import rcParamVerifyGUIImpl

class rcParamVerifier(object):
  """!\brief Parameter verifier class.

  This class gets activated during a secure session and
  is used to get a sign off on the parameters specified
  in the ScriptEngine GUI in addition to the parameters
  specified in the test script itself.

  The scripts can add additional parameters to be verified
  by calling the add method.
  """
  def __init__(self, common, parent = None, name = None, fl = 0):
    """!\brief rcParamVerifier constructor.

    \param common ScriptEngineCommon instance
    \param parent Parent GUI
    \param name   GUI name
    \param fl     GUI flag
    """
    self.__verifyGUI = rcParamVerifyGUIImpl(common, parent, name, fl)
    self.__common = common

  def initialize(self, testName):
    """!\brief Initialize the parameter verifier.

    \param testName Name of the test script
    """
    self.__parNames = []
    self.__parValues = []
    self.__testName = testName

  def add(self, parName, parValue):
    """!\brief Add parameter and its value to the verify list

    \param parName Parameter name or description
    \param parValue Parameter value that the operator inputted
    """
    if parName not in self.__parNames:
      self.__parNames.append(parName)
      self.__parValues.append(parValue)
    else:
      raise KeyError, "Parameter with name: %s already added." % parName

  def getParameters(self, parName=None):
    """!\brief Retrieve parameters to verify

    \param parName Parameter to retrieve from the verify list (optional)

    \return A list containing the parameter name and value tuple if \a parName is specified or
            A list of parameter name and value tuples if \a parName is None.
    """
    if parName is not None:
      if parName in self.__parNames:
        return [(parName, self.__parValues[self.__parNames.index(parName)])]
    else:
      return map(None, self.__parNames, self.__parValues)

  def verify(self):
    """!\brief Fill the GUI with data and show it.

    \return 1: If all the parameters have been verified.
            0: If there are no parameters or if the operator
               hit cancel.
    """
    if len(self.getParameters()) > 0:
      self.__verifyGUI.initialize(self.__testName)
      for (parName, parValue) in self.getParameters():
        self.__verifyGUI.addParameter(parName, parValue)
      self.__verifyGUI.show()
      return self.__verifyGUI.exec_loop()
    else:
      return 1

---