Table of Contents

Class: MadrigalDirectory ui/userData.py

MadrigalDirectory is a public object that provides access to information in a single user directory.

The MadrigalDirectory object is designed to allow easy access to the information in one directory of user data. At the moment this data is the directory name, the directory type, and a list of filternames in that directory. Created by MadrigalUserData.getAllDirInfo()

Usage example:

        import madrigal.ui.userData

        test = madrigal.ui.userData.MadrigalUserData()

        userDirInfo = test.getAllDirInfo()

        # print all the directory information for user brideout

        for madDir in userDirInfo['brideout']:

            print 'Directory name is ' + madDir.dirName

            print 'This directory type (public or private) is ' + madDir.dirType

            print 'The filter names in this directory are:'

            for filtername in madDir.filterList:

                print '    ' + filtername

Non-standard Python modules used: None

Exceptions thrown: None

Change history:

Written by Bill Rideout Dec. 11, 2001

Methods   
__init__
toString
  __init__ 
__init__ (
        self,
        dirName,
        dirType,
        )

__init__ initializes MadrigalDirectory by initializing the class members from the inputs.

Inputs: dirName - case sensitive name of directory (string), dirType = public or private (string).

Returns: void

Affects: Initializes all the class member variables. All member variables are public.

Exceptions: None.

  toString 
toString ( self )


Table of Contents

This document was automatically generated on Fri Dec 30 09:02:26 2005 by HappyDoc version r1_5