Table of Contents

Class: MadrigalExperimentFile madrigalWeb/madrigalWeb.py

MadrigalExperimentFile is a class that encapsulates information about a Madrigal ExperimentFile.

Attributes:

        name (string) Example '/opt/mdarigal/blah/mlh980120g.001'

        kindat (int) Kindat code.  Example: 3001

        kindatdesc (string) Kindat description: Example 'Basic Derived Parameters'

        category (int) (1=default, 2=variant, 3=history, 4=real-time)

        status (string)('preliminary', 'final', or any other description)

        permission (int)  0 for public, 1 for private

        expId - experiment id of the experiment this MadrigalExperimentFile belongs in

Non-standard Python modules used: None

Change history:

Written by Bill Rideout Feb. 10, 2004

Methods   
__init__
__str__
  __init__ 
__init__ (
        self,
        name,
        kindat,
        kindatdesc,
        category,
        status,
        permission,
        expId=None,
        )

__init__ initializes a MadrigalExperimentFile.

Inputs:

            name - (string) Example '/opt/mdarigal/blah/mlh980120g.001'

            kindat - (int, or string that can be converted) Kindat code.  Example: 3001

            kindatdesc - (string) Kindat description: Example 'Basic Derived Parameters'

            category - (int, or string that can be converted) (1=default, 2=variant, 3=history, 4=real-time)

            status - (string)('preliminary', 'final', or any other description)

            permission - (int, or string that can be converted)  0 for public, 1 for private

            expId - experiment id of the experiment this MadrigalExperimentFile belongs in

Returns: void

Affects: Initializes all the class member variables.

Exceptions: If illegal argument passed in.

Exceptions   
ValueError, 'In MadrigalExperimentFile, kindatdesc not string type: %s' %(str( kindatdesc ) )
ValueError, 'In MadrigalExperimentFile, name not string type: %s' %(str( name ) )
ValueError, 'In MadrigalExperimentFile, status not string type: %s' %(str( status ) )
  __str__ 
__str__ ( self )

return a readible form of this object


Table of Contents

This document was automatically generated on Wed Jul 2 15:58:53 2008 by HappyDoc version r1_5