Table of Contents

Class: CdfOptions sam/analysis/CDF.py

Handles getting the options needed for cdf analysis from the user.

Purpose: Creates a GUI which gets the options needed from the user.

Used by: cdf

Uses: libglade, ErrorHandler, gtk

Attributes: None

SRS Refs: 3.2.1.4

Author: mayadm

Date: 31/7/02

Methods   
__init__
cancel
getNumBins
handleNext
run
  __init__ 
__init__ ( self )

Purpose: Creates a new instance of the class CdfOptions. If the environment variable RAMI_SAM_DIR is set, the glade file is looked for in that directory, otherwise looked for in the current directory. The number of bins displayed on screen is initially set to 10 as default.

Used by: cdf

Uses: libglade

Input: None

Output: New instance of the class CdfOptions

Preconditions: The file spec_filename contains the glade file with CdfOptions' widget tree, called "pdfoptions".

Postconditions: None

SRS Refs: 3.2.1.4

Author: mayadm

Date: 31/7/02

  cancel 
cancel ( self,  *args )

Purpose: Cancels the analysis run.

Used by: cdf

Uses: None

Input: *args : unused arguments

Output: None

Preconditions: A gtk mainloop has started.

Postconditions: None

SRS Refs: 3.2.1.4

Author: lljy

Date: 5/10/02

  getNumBins 
getNumBins ( self )

Purpose: Returns the number of bins that the user wants. If user has not changed the default (10), the number of bins remains at 10.

Used by: cdf

Uses: None

Input: None

Output: getNumBins : integer (positive)

Preconditions: None

Postconditions: None

SRS Refs: 3.2.1.4

Author: mayadm

Date: 31/7/02

  handleNext 
handleNext ( self,  *args )

Purpose: Handles the user clicking on the Next button, at which point the gui must be hidden and control returned to the calling function. Checks to see that the user has entered a positive integer; if not, an error message is displayed and the user is told to enter another number.

Used by: CdfOptions

Uses: gtk, ErrorHandler

Input: *args : unused arguments

Output: None

Preconditions: A mainloop() has been entered and the name of the widget tree in the glade file is "pdfoptions"

Postconditions: The mainloop() has been exited

SRS Refs: 3.2.1.4

Author: mayadm

Date: 31/7/02

Exceptions   
ValueError, "Error - must enter a positive integer"
  run 
run ( self )

Purpose: Runs a mainloop for the user to select options for the analysis before the analysis is performed.

Used by: cdf

Uses: gtk

Input: None

Output: None

Preconditions: None

Postconditions: A mainloop() has been entered.

SRS Refs: 3.2.1.4

Author: mayadm

Date: 31/7/02


Table of Contents

This document was automatically generated on Wed Oct 30 23:04:21 2002 by HappyDoc version 2.0