Table of Contents

Class: MadrigalInstrument madrigalWeb/madrigalWeb.py

MadrigalInstrument is a class that encapsulates information about a Madrigal Instrument.

Attributes:

      name (string) Example: 'Millstone Hill Incoherent Scatter Radar'

      code (int) Example: 30

      mnemonic (3 char string) Example: 'mlh'

      latitude (double) Example: 45.0

      longitude (double) Example: 110.0

      altitude (double)  Example: 0.015 (km)

      category (string) Example 'Incoherent Scatter Radars'

Non-standard Python modules used: None

Change history:

Written by Bill Rideout Feb. 10, 2004

Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        name,
        code,
        mnemonic,
        latitude,
        longitude,
        altitude,
        category='unknown',
        )

__init__ initializes a MadrigalInstrument.

Inputs:

            name - (string) Example: 'Millstone Hill Incoherent Scatter Radar'

            code - (int, or string that can be converted) Example: 30

            mnemonic - (3 char string) Example: 'mlh'

            latitude - (double, or string that can be converted) Example: 45.0

            longitude (double, or string that can be converted) Example: 110.0

            altitude (double, or string that can be converted)  Example: 0.015 (km)

            category  (string) Example: 'Incoherent Scatter Radars'

Returns: void

Affects: Initializes all the class member variables.

Exceptions: If illegal argument passed in.

Exceptions   
ValueError, 'In MadrigalInstrument, mnemonic not string type: %s' %(str( mnemonic ) )
ValueError, 'In MadrigalInstrument, mnemonic not three characters: %s' %(str( mnemonic ) )
ValueError, 'In MadrigalInstrument, name not string type: %s' %(str( name ) )
  __str__  
__str__ ( self )

return a readible form of this object

Table of Contents

This document was automatically generated on Tue Mar 20 11:30:53 2012 by HappyDoc version r1_5