ucar.unidata.data
Class VarInfo

java.lang.Object
  ucar.unidata.data.VarInfo

public class VarInfo
extends Object

Class Variable Holds info about track variables

Version:

$Revision: 1.4 $

Author:

IDV Development Team

Constructor Summary

VarInfo(String name, String units)
ctor

VarInfo(String name, String desc, String units)
ctor

VarInfo(String name, String desc, String category, Unit unit)
ctor

VarInfo(String name, String desc, String category, Unit unit, double missingValue)
ctor

VarInfo(String name, String desc, Unit unit)
ctor

VarInfo(String name, Unit unit)
ctor

Method Summary

String	getCategory() Get the Category property.
String	getDescription() get desc
boolean	getIsNumeric() Get the IsNumeric property.
double	getMissingValue() Get the MissingValue property.
String	getName() get the name
RealType	getRealType() Get the RealType property.
String	getShortName() get the name
Unit	getUnit() Get the Unit property.
static VarInfo	getVarInfo(String variableName, List<VarInfo> variables) Utility to find the variable with the given name
void	setCategory(String value) Set the Category property.
void	setIsNumeric(boolean value) Set the IsNumeric property.
void	setMissingValue(double value) Set the MissingValue property.
void	setRealType(RealType value) Set the RealType property.
void	setUnit(Unit value) Set the Unit property.
String	toString() to string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VarInfo

public VarInfo(String name,
               String desc,
               Unit unit)

ctor

Parameters:

name - name

desc - desc

unit - unit

VarInfo

public VarInfo(String name,
               String desc,
               String category,
               Unit unit)

ctor

Parameters:

name - name

desc - desc

category - the category of the var

unit - unit

VarInfo

public VarInfo(String name,
               String desc,
               String category,
               Unit unit,
               double missingValue)

ctor

Parameters:

name - name

desc - desc

category - the category of the var

unit - unit

missingValue - missing value

VarInfo

public VarInfo(String name,
               Unit unit)

ctor

Parameters:

name - name

unit - unit

VarInfo

public VarInfo(String name,
               String units)

ctor

Parameters:

name - name

units - unit string

VarInfo

public VarInfo(String name,
               String desc,
               String units)

ctor

Parameters:

name - name

desc - description

units - unit string

Method Detail

getVarInfo

public static VarInfo getVarInfo(String variableName,
                                 List<VarInfo> variables)

Utility to find the variable with the given name

Parameters:

variableName - The name

variables - List of variables to look into

Returns:

The variable.

getName

public String getName()

get the name

Returns:

name

getShortName

public String getShortName()

get the name

Returns:

name

getDescription

public String getDescription()

get desc

Returns:

desc

setCategory

public void setCategory(String value)

Set the Category property.

Parameters:

value - The new value for Category

getCategory

public String getCategory()

Get the Category property.

Returns:

The Category

toString

public String toString()

to string

Overrides:

toString in class Object

Returns:

to string

setIsNumeric

public void setIsNumeric(boolean value)

Set the IsNumeric property.

Parameters:

value - The new value for IsNumeric

getIsNumeric

public boolean getIsNumeric()

Get the IsNumeric property.

Returns:

The IsNumeric

setRealType

public void setRealType(RealType value)

Set the RealType property.

Parameters:

value - The new value for RealType

getRealType

public RealType getRealType()

Get the RealType property.

Returns:

The RealType

setUnit

public void setUnit(Unit value)

Set the Unit property.

Parameters:

value - The new value for Unit

getUnit

public Unit getUnit()

Get the Unit property.

Returns:

The Unit

setMissingValue

public void setMissingValue(double value)

Set the MissingValue property.

Parameters:

value - The new value for MissingValue

getMissingValue

public double getMissingValue()

Get the MissingValue property.

Returns:

The MissingValue