MadrigalParameter is a class that encapsulates information about a Madrigal Parameter.
Attributes:
mnemonic (string) Example 'dti'
description (string) Example: "F10.7 Multiday average observed (Ott)"
isError (int) 1 if error parameter, 0 if not
units (string) Example "W/m2/Hz"
isMeasured (int) 1 if measured, 0 if derivable
category (string) Example: "Time Related Parameter"
isSure (int) - 1 if parameter can be found for every record, 0 if can only be found for some
isAddIncrement - 1 if additional increment, 0 if normal, -1 if unknown (this capability
only added with Madrigal 2.5)
Non-standard Python modules used: None
Change history:
Written by Bill Rideout Aug. 8, 2005
|
Methods
|
|
__init__
__str__
|
|
|
__init__
|
__init__ (
self,
mnemonic,
description,
isError,
units,
isMeasured,
category,
isSure,
isAddIncrement,
)
__init__ initializes a MadrigalParameter.
Inputs:
mnemonic (string) Example 'dti'
description (string) Example: "F10.7 Multiday average observed (Ott)"
isError (int) 1 if error parameter, 0 if not
units (string) Example "W/m2/Hz"
isMeasured (int) 1 if measured, 0 if derivable
category (string) Example: "Time Related Parameter"
isSure (int) - 1 if parameter can be found for every record, 0 if can only be found for some
isAddIncrement - 1 if additional increment, 0 if normal, -1 if unknown (this capability
only added with Madrigal 2.5)
Returns: void
Affects: Initializes all the class member variables.
Exceptions: If illegal argument passed in.
|
Exceptions
|
|
ValueError, 'In MadrigalParameter, category not string type: %s' %(str( category ) )
ValueError, 'In MadrigalParameter, description not string type: %s' %(str( description ) )
ValueError, 'In MadrigalParameter, mnemonic not string type: %s' %(str( mnemonic ) )
ValueError, 'In MadrigalParameter, units not string type: %s' %(str( units ) )
|
|
|
|
__str__
|
__str__ ( self )
return a readible form of this object
|
|