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