public abstract class Units
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static Units |
ampRatio |
static Units |
bytes |
static Units |
bytesPerSecond |
static TimeLocationUnits |
cdfEpoch
cdf epoch milliseconds since midnight, 01-Jan-0000, excluding those with a leap second.
|
static TimeLocationUnits |
cdfTT2000
the number of nanoseconds since 01-Jan-2000T12:00, roughly.
|
static Units |
celciusDegrees |
static Units |
centigrade
begin of LocationUnits.
|
static Units |
centimeters |
static Units |
cm_2s_1keV_1 |
static Units |
cm_2s_1MeV_1 |
static Units |
cmps |
static Units |
days |
static Units |
dB
Define a set of units to describe ratiometric (logarithmic) spacing.
|
static LocationUnits |
decimalYear
the year plus the fraction into the current year, ((doy-1)/365) for non-leap years.
|
static Units |
deg |
static Units |
degrees |
static Units |
degrees2 |
static Units |
dimensionless |
static Units |
dollars
currencies for demonstration purposes.
|
static Units |
euros |
static Units |
ev |
static Units |
eV |
static Units |
fahrenheitDegrees |
static Units |
fahrenheitScale |
static Units |
gigaHertz |
static Units |
hertz |
static Units |
hours |
static Units |
hours2 |
static Units |
inches |
static TimeLocationUnits |
julianDay
The Julian Day (MJD) is the number of days (with decimal fraction of the day) that have elapsed since noon on January 1, 4713 BCE.
|
static Units |
kelvin |
static Units |
keV |
static Units |
kiloBytes |
static Units |
kiloBytesPerSecond |
static Units |
kiloHertz |
static Units |
kiloMeters |
static Units |
log10Ratio |
static Units |
logERatio |
static Units |
megaHertz |
static Units |
meters |
static Units |
MeV |
static Units |
microseconds |
static Units |
microseconds2 |
static Units |
microseconds3 |
static Units |
millimeters |
static Units |
milliseconds |
static Units |
milliseconds2 |
static Units |
minutes |
static TimeLocationUnits |
mj1958
roughly days since on midnight on 1958-01-01, Julian - 2436204.5 to be more precise.
|
static TimeLocationUnits |
mjd
The Modified Julian Day (MJD) is the number of days (with decimal fraction of the day) that have elapsed since midnight at the beginning of Wednesday November 17, 1858.
|
static Units |
mps |
static TimeLocationUnits |
ms1970
milliseconds since midnight Jan 1, 1970, excluding leap seconds.
|
static Units |
nanoseconds |
static Units |
ns |
static Units |
nT |
static Units |
pcm3
1 / cm3
|
static Units |
percent
ratiometric units
|
static Units |
percentIncrease |
static Units |
picoseconds |
static Units |
radians |
static Units |
rgbColor
It's often enough that we just want to paint data with a particular color that
there's a special unit which is used to trigger a branch, and the color will
be used.
|
static Units |
rupee |
static Units |
seconds |
static Units |
seconds2 |
static TimeLocationUnits |
t1970
seconds since midnight Jan 1, 1970, excluding leap seconds.
|
static TimeLocationUnits |
t2000
Seconds since midnight Jan 1, 2000, excluding leap seconds.
|
static TimeLocationUnits |
t2010
Seconds since midnight Jan 1, 2010, excluding leap seconds.
|
static Units |
typographicPoints |
static TimeLocationUnits |
us1970
milliseconds since midnight Jan 1, 1970, excluding leap seconds.
|
static TimeLocationUnits |
us1980
Microseconds since midnight Jan 1, 1980, excluding those within a leap second.
|
static TimeLocationUnits |
us2000
Microseconds since midnight Jan 1, 2000, excluding those within a leap second.
|
static TimeLocationUnits |
us2020
Microseconds since midnight Jan 1, 2020, excluding those within a leap second.
|
static Units |
v2pm2Hz
Volts 2 m-2 Hz-1
|
static Units |
wpm2
Watts / m2
|
static Units |
years |
static Units |
yen |
Modifier | Constructor and Description |
---|---|
protected |
Units(java.lang.String id) |
protected |
Units(java.lang.String id,
java.lang.String description) |
Modifier and Type | Method and Description |
---|---|
abstract Datum |
add(java.lang.Number a,
java.lang.Number b,
Units bUnits) |
double |
convertDoubleTo(Units toUnits,
double value)
convert the double in this units' space to toUnits' space.
|
abstract Datum |
createDatum(Datum value)
create a Datum with the units.
|
abstract Datum |
createDatum(double value) |
abstract Datum |
createDatum(double value,
double resolution) |
abstract Datum |
createDatum(int value) |
abstract Datum |
createDatum(long value) |
abstract Datum |
createDatum(java.lang.Number value) |
abstract Datum |
divide(java.lang.Number a,
java.lang.Number b,
Units bUnits) |
java.lang.String |
format(Datum datum)
format the Datum.
|
static java.util.List<Units> |
getAllUnits()
return all the known units.
|
Basis |
getBasis()
return the Basis which defines the meaning of zero and the direction of positive values, such as
"since midnight, Jan 1, 1970"
|
static Units |
getByName(java.lang.String s)
returns a Units object with the given string representation that is stored in the unitsMap.
|
static Units |
getCanonicalUnit(Units units)
return the preferred unit to use when there are multiple representations
of the same unit (having conversion UnitsConverter.IDENTITY).
|
UnitsConverter |
getConverter(Units toUnits)
Get the converter that goes from this Unit to toUnits.
|
static UnitsConverter |
getConverter(Units fromUnits,
Units toUnits)
lookup the UnitsConverter object that takes numbers from fromUnits to toUnits.
|
Units[] |
getConvertibleUnits()
return the units to which this unit is convertible.
|
abstract DatumFormatterFactory |
getDatumFormatterFactory()
return the formatter factor for this Datum.
|
Datum |
getFillDatum() |
double |
getFillDouble() |
java.lang.String |
getId()
get the id uniquely identifying the units.
|
Units |
getOffsetUnits()
return the units from the Basis for the unit, such as "seconds" in
"seconds since midnight, Jan 1, 1970"
|
java.lang.String |
grannyFormat(Datum datum)
format the Datum, allowing use of subscripts and superscripts interpretted by GrannyTextRenderer.
|
boolean |
isConvertibleTo(Units toUnits)
return true if the unit can be converted to toUnits.
|
boolean |
isFill(double value) |
boolean |
isFill(java.lang.Number value) |
boolean |
isValid(double value)
test if the double represents a valid datum in the context of this unit.
|
static Units |
lookupTimeLengthUnit(java.lang.String s)
return canonical das2 unit for colloquial time.
|
static Units |
lookupTimeUnits(Datum base,
Units offsetUnits)
lookupUnits canonical units object, or allocate one.
|
static Units |
lookupTimeUnits(java.lang.String units)
lookupUnits canonical units object, or allocate one.
|
static Units |
lookupUnits(java.lang.String sunits)
lookupUnits canonical units object, or allocate one if the
unit has not been used already.
|
static void |
main(java.lang.String[] args) |
abstract Datum |
multiply(java.lang.Number a,
java.lang.Number b,
Units bUnits) |
static EnumerationUnits |
nominal()
return unit for identifying nominal data.
|
static EnumerationUnits |
nominal(java.lang.String nameSpace)
return unit for identifying nominal data.
|
abstract Datum |
parse(java.lang.String s)
parse the string in the context of these units.
|
void |
registerConverter(Units toUnits,
UnitsConverter converter)
register a converter between the units.
|
abstract Datum |
subtract(java.lang.Number a,
java.lang.Number b,
Units bUnits) |
java.lang.String |
toString() |
public static final Units dimensionless
public static final Units radians
public static final Units degrees
public static final Units deg
public static final Units degrees2
public static final Units rgbColor
public static final Units celciusDegrees
public static final Units fahrenheitDegrees
public static final Units years
public static final Units days
public static final Units hours
public static final Units hours2
public static final Units minutes
public static final Units seconds
public static final Units seconds2
public static final Units milliseconds
public static final Units milliseconds2
public static final Units microseconds
public static final Units microseconds2
public static final Units microseconds3
public static final Units nanoseconds
public static final Units ns
public static final Units picoseconds
public static final Units bytesPerSecond
public static final Units kiloBytesPerSecond
public static final Units bytes
public static final Units kiloBytes
public static final Units hertz
public static final Units kiloHertz
public static final Units megaHertz
public static final Units gigaHertz
public static final Units eV
public static final Units ev
public static final Units keV
public static final Units MeV
public static final Units pcm3
public static final Units kelvin
public static final Units cm_2s_1keV_1
public static final Units cm_2s_1MeV_1
public static final Units v2pm2Hz
public static final Units wpm2
public static final Units meters
public static final Units millimeters
public static final Units centimeters
public static final Units kiloMeters
public static final Units inches
public static final Units typographicPoints
public static final Units nT
public static final Units cmps
public static final Units mps
public static final Units centigrade
public static final Units fahrenheitScale
public static final Units dollars
public static final Units euros
public static final Units yen
public static final Units rupee
public static final TimeLocationUnits us2020
public static final TimeLocationUnits us2000
public static final TimeLocationUnits us1980
public static final TimeLocationUnits t2010
public static final TimeLocationUnits t2000
public static final TimeLocationUnits t1970
public static final TimeLocationUnits ms1970
public static final TimeLocationUnits us1970
public static final TimeLocationUnits mj1958
public static final TimeLocationUnits mjd
public static final TimeLocationUnits julianDay
public static final TimeLocationUnits cdfEpoch
public static final TimeLocationUnits cdfTT2000
public static final LocationUnits decimalYear
public static final Units percent
public static final Units dB
public static final Units ampRatio
public static final Units percentIncrease
public static final Units log10Ratio
public static final Units logERatio
protected Units(java.lang.String id)
protected Units(java.lang.String id, java.lang.String description)
public static Units getCanonicalUnit(Units units)
units
- public java.lang.String getId()
public void registerConverter(Units toUnits, UnitsConverter converter)
toUnits
- the target unitsconverter
- the converter that goes from this unit to target units.public Units[] getConvertibleUnits()
public boolean isConvertibleTo(Units toUnits)
toUnits
- Units object.public static UnitsConverter getConverter(Units fromUnits, Units toUnits)
fromUnits
- units instance that is the source units.toUnits
- units instance that is the target units.InconvertibleUnitsException
- when the conversion is not possible.public UnitsConverter getConverter(Units toUnits)
toUnits
- java.lang.IllegalArgumentException
- if conversion between units is not possiblepublic double convertDoubleTo(Units toUnits, double value)
toUnits
- the units.value
- the value in toUnits.InconvertibleUnitsException
- when the conversion is not possible.public java.lang.String toString()
toString
in class java.lang.Object
public Units getOffsetUnits()
public Basis getBasis()
public abstract Datum createDatum(double value)
public abstract Datum createDatum(int value)
public abstract Datum createDatum(long value)
public abstract Datum createDatum(java.lang.Number value)
public abstract Datum createDatum(Datum value)
value
- public abstract Datum createDatum(double value, double resolution)
public double getFillDouble()
public Datum getFillDatum()
public boolean isFill(double value)
public boolean isFill(java.lang.Number value)
public boolean isValid(double value)
value
- the value to check.public abstract DatumFormatterFactory getDatumFormatterFactory()
public abstract Datum parse(java.lang.String s) throws java.text.ParseException
s
- java.text.ParseException
public java.lang.String format(Datum datum)
datum
- the Datumpublic java.lang.String grannyFormat(Datum datum)
datum
- the Datumpublic static java.util.List<Units> getAllUnits()
public static Units getByName(java.lang.String s)
s
- units identifierjava.lang.IllegalArgumentException
- if the unit is not recognized.lookupUnits(java.lang.String)
public static Units lookupTimeLengthUnit(java.lang.String s) throws java.text.ParseException
s
- string containing time unit like s, sec, millisec, etc.java.text.ParseException
public static Units lookupTimeUnits(Datum base, Units offsetUnits)
base
- the base time, for example 2000-001T00:00.offsetUnits
- the offset units for example microseconds. Positive values of the units will be since the base time.public static Units lookupTimeUnits(java.lang.String units) throws java.text.ParseException
units
- string like "microseconds since 2000-001T00:00" which will be the id.java.text.ParseException
- if the time cannot be parsed, etc.public static Units lookupUnits(java.lang.String sunits)
sunits
- string identifier.getByName(java.lang.String)
public static EnumerationUnits nominal()
public static EnumerationUnits nominal(java.lang.String nameSpace)
nameSpace
- public static void main(java.lang.String[] args) throws java.text.ParseException
java.text.ParseException