ucar.grid
Class GridParameter

java.lang.Object
  extended by ucar.grid.GridParameter
Direct Known Subclasses:
GempakParameter

public class GridParameter
extends Object

Class which represents a grid parameter. A parameter consists of a number that can be used to look up in a table, a name( ie Temperature), a description( ie Temperature at 2 meters), and Units( ie K ).


Field Summary
protected  String description
          description of parameter.
protected  String name
          name of parameter.
protected  int number
          parameter number.
protected  String unit
          unit of Parameter.
 
Constructor Summary
GridParameter()
          constructor.
GridParameter(int number, String name, String description, String unit)
          constructor.
 
Method Summary
 boolean equals(Object o)
          Check for equality
 String getDescription()
          description of parameter.
 String getName()
          name of parameter.
 int getNumber()
          number of parameter.
 String getUnit()
          unit of parameter.
 int hashCode()
          Generate a hash code.
 void setDescription(String description)
          sets description of parameter.
 void setName(String name)
          sets name of parameter.
 void setNumber(int number)
          sets number of parameter.
 void setUnit(String unit)
          sets unit of parameter.
 String toString()
          Return a String representation of this object
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

number

protected int number
parameter number.


name

protected String name
name of parameter.


description

protected String description
description of parameter.


unit

protected String unit
unit of Parameter.

Constructor Detail

GridParameter

public GridParameter()
constructor.


GridParameter

public GridParameter(int number,
                     String name,
                     String description,
                     String unit)
constructor.

Parameters:
number -
name -
description -
unit - of parameter
Method Detail

getNumber

public final int getNumber()
number of parameter.

Returns:
number

getName

public final String getName()
name of parameter.

Returns:
name

getDescription

public final String getDescription()
description of parameter.

Returns:
description

getUnit

public final String getUnit()
unit of parameter.

Returns:
unit

setNumber

public final void setNumber(int number)
sets number of parameter.

Parameters:
number - of parameter

setName

public final void setName(String name)
sets name of parameter.

Parameters:
name - of parameter

setDescription

public final void setDescription(String description)
sets description of parameter.

Parameters:
description - of parameter

setUnit

public final void setUnit(String unit)
sets unit of parameter.

Parameters:
unit - of parameter

toString

public String toString()
Return a String representation of this object

Overrides:
toString in class Object
Returns:
a String representation of this object

equals

public boolean equals(Object o)
Check for equality

Overrides:
equals in class Object
Parameters:
o - the object in question
Returns:
true if has the same parameters

hashCode

public int hashCode()
Generate a hash code.

Overrides:
hashCode in class Object
Returns:
the hash code


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.