net.sourceforge.jgrib
Class GribPDSParameter

java.lang.Object
  extended by net.sourceforge.jgrib.GribPDSParameter

public class GribPDSParameter
extends java.lang.Object

Title: JGrib Description: Class which represents a parameter from a PDS parameter table Copyright: Copyright (c) 2002 Company: U.S. Air Force

Version:
1.0
Author:
Capt Richard D. Gonzalez

Field Summary
protected  java.lang.String description
          Parameter description
protected  java.lang.String name
          Parameter name
protected  int number
          Parameter number [0 - 255]
protected  java.lang.String unit
          Parameter unit
 
Constructor Summary
GribPDSParameter()
          Constuctor - Default
GribPDSParameter(int aNum, java.lang.String aName, java.lang.String aDesc, java.lang.String aUnit)
          Constructor
 
Method Summary
 int compare(GribPDSParameter param)
          rdg - added this method to be used in a comparator for sorting while extracting records.
 boolean equals(java.lang.Object obj)
          Overrides Object.equals()
 java.lang.String getDescription()
           
 java.lang.String getName()
           
 int getNumber()
           
 java.lang.String getUnit()
           
 java.lang.String toString()
          Overrides Object.toString()
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

number

protected int number
Parameter number [0 - 255]


name

protected java.lang.String name
Parameter name


description

protected java.lang.String description
Parameter description


unit

protected java.lang.String unit
Parameter unit

Constructor Detail

GribPDSParameter

public GribPDSParameter()
Constuctor - Default


GribPDSParameter

public GribPDSParameter(int aNum,
                        java.lang.String aName,
                        java.lang.String aDesc,
                        java.lang.String aUnit)
Constructor

Parameters:
aNum - - Parameter number
aName - - Parameter name
aDesc - - Parameter description
aUnit - - Parameter unit
Method Detail

getNumber

public int getNumber()
Returns:
Parameter number

getName

public java.lang.String getName()
Returns:
Parameter name

getDescription

public java.lang.String getDescription()
Returns:
Parameter description

getUnit

public java.lang.String getUnit()
Returns:
Parameter unit

toString

public java.lang.String toString()
Overrides Object.toString()

Overrides:
toString in class java.lang.Object
Returns:
String representation of the parameter
See Also:
Object.toString()

equals

public boolean equals(java.lang.Object obj)
Overrides Object.equals()

Overrides:
equals in class java.lang.Object
Returns:
true/false
See Also:
Object.equals(java.lang.Object)

compare

public int compare(GribPDSParameter param)
rdg - added this method to be used in a comparator for sorting while extracting records. Not currently used in the JGrib library, but is used in a library I'm using that uses JGrib.

Parameters:
param - to compare
Returns:
- -1 if level is "less than" this, 0 if equal, 1 if level is "greater than" this.