|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.units.SimpleUnit
public class SimpleUnit
Convenience routines on top of ucar.units package.
The ucar.units package handles
Field Summary | |
---|---|
static SimpleUnit |
kmUnit
|
static SimpleUnit |
meterUnit
|
static SimpleUnit |
pressureUnit
|
Method Summary | |
---|---|
double |
convertTo(double value,
SimpleUnit outputUnit)
Convert given value of this unit to the new unit. |
static SimpleUnit |
factory(java.lang.String name)
Create a SimpleUnit from the given name, catch Exceptions. |
static SimpleUnit |
factoryWithExceptions(java.lang.String name)
Create a SimpleUnit from the given name, allow Exceptions. |
java.lang.String |
getCanonicalString()
|
static double |
getConversionFactor(java.lang.String inputUnitString,
java.lang.String outputUnitString)
Get the conversion factor to convert inputUnit to outputUnit. |
java.lang.String |
getImplementingClass()
|
ucar.units.Unit |
getUnit()
Get underlying ucar.units.Unit. |
java.lang.String |
getUnitString()
Extract the simple unit string (no number), eg "s" or "m". |
double |
getValue()
Extract the value, can only be called for ScaledUnit. |
boolean |
isCompatible(java.lang.String unitString)
Return true if unitString1 is compatible to unitString2, meaning one can be converted to the other. |
static boolean |
isCompatible(java.lang.String unitString1,
java.lang.String unitString2)
Return true if unitString1 is compatible to unitString2, meaning one can be converted to the other. |
static boolean |
isCompatibleWithExceptions(java.lang.String unitString1,
java.lang.String unitString2)
Return true if unitString1 is convertible to unitString2 |
static boolean |
isDateUnit(java.lang.String unitString)
Return true if the given unit is convertible to a date Unit. |
static boolean |
isDateUnit(ucar.units.Unit uu)
Return true if this ucar.units.Unit is a Date. |
static boolean |
isTimeUnit(java.lang.String unitString)
Return true if the given unit is a time Unit, eg "seconds". |
static boolean |
isTimeUnit(ucar.units.Unit uu)
Return true if this ucar.units.Unit is convertible to secs. |
boolean |
isUnknownUnit()
Is this an instance of an UnknownUnit? |
java.lang.String |
toString()
Unit string representation. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SimpleUnit kmUnit
public static final SimpleUnit meterUnit
public static final SimpleUnit pressureUnit
Method Detail |
---|
public static SimpleUnit factory(java.lang.String name)
name
- parse this name to create a unit.
UnitFormat.parse(java.lang.String)
public static SimpleUnit factoryWithExceptions(java.lang.String name) throws java.lang.Exception
name
- parse this name to create a unit.
java.lang.Exception
- when date parser failsUnitFormat.parse(java.lang.String)
public static boolean isCompatible(java.lang.String unitString1, java.lang.String unitString2)
unitString1
- compare this unitunitString2
- compare this unit
public static boolean isCompatibleWithExceptions(java.lang.String unitString1, java.lang.String unitString2) throws java.lang.Exception
unitString1
- compare this unitunitString2
- compare this unit
java.lang.Exception
- if units parsing failspublic static boolean isDateUnit(ucar.units.Unit uu)
uu
- check this Unit
public static boolean isTimeUnit(ucar.units.Unit uu)
uu
- check this Unit
public static boolean isDateUnit(java.lang.String unitString)
[-]Y[Y[Y[Y]]]-MM-DD[(T| )hh[:mm[:ss[.sss*]]][ [+|-]hh[[:]mm]]]
unitString
- check this unit string
public static boolean isTimeUnit(java.lang.String unitString)
unitString
- check this unit string
public static double getConversionFactor(java.lang.String inputUnitString, java.lang.String outputUnitString) throws java.lang.IllegalArgumentException
inputUnitString
- inputUnit in string formoutputUnitString
- outputUnit in string form
java.lang.IllegalArgumentException
- if not convertiblepublic java.lang.String toString()
toString
in class java.lang.Object
public ucar.units.Unit getUnit()
public double convertTo(double value, SimpleUnit outputUnit) throws java.lang.IllegalArgumentException
value
- value in this unitoutputUnit
- convert to this unit
java.lang.IllegalArgumentException
- if outputUnit not convertible from this unitpublic boolean isCompatible(java.lang.String unitString)
unitString
- check if this is compatible with unitString
public boolean isUnknownUnit()
public double getValue()
public java.lang.String getUnitString()
public java.lang.String getCanonicalString()
public java.lang.String getImplementingClass()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |