ucar.nc2.units

Class TimeUnit

java.lang.Object

ucar.nc2.units.SimpleUnit

ucar.nc2.units.TimeUnit

public class TimeUnit
extends SimpleUnit

Handles Units that are time durations, eg in seconds, hours, days, years. It keeps track of the original unit name, rather than converting to canonical "seconds". The unit name never changes, but the value may (will be Immutable in ver7)

This is a wrapper around ucar.units. The underlying ucar.units.Unit always has a value of "1.0", ie is a base unit. TODO: 8/12/2020 make Immutable in version 7

Field Summary

Fields inherited from class ucar.nc2.units.SimpleUnit

dateReferenceUnit, debugParse, kmUnit, meterUnit, pressureUnit, secsUnit, uu

Constructor Summary

Constructors

Constructor and Description
TimeUnit(double value, String unitString) Constructor from a value and a unit name.
TimeUnit(String text) Constructor from a String.
TimeUnit(TimeUnit src) Copy Constructor.

Method Summary

Modifier and Type	Method and Description
CalendarDate	add(CalendarDate cd) Add the time amount to the given Date, return a new Date.
Date	add(Date d) Deprecated. use add(CalendarDate)
double	convertTo(double value, TimeUnit outputUnit) Convert given value of this unit to the new unit.
boolean	equals(Object o) TimeUnits with same value and unitString are equal
double	getFactor() Get the factor that converts this unit to seconds.
String	getUnitString() Get the "base" unit String, eg "secs" or "days"
double	getValue() Get the value.
double	getValueInSeconds() Get the time duration in seconds.
double	getValueInSeconds(double value) Get the time duration in seconds of the specified value.
int	hashCode() Override hashcode to be consistent with equals.
TimeUnit	newValue(double value) Create a new TimeUnit with the given value.
TimeUnit	newValueInSeconds(double secs) Create a new TimeUnit with the given value in seconds.
void	setValue(double value) Deprecated. use newValue(double)
void	setValueInSeconds(double secs) Deprecated. use newValueInSeconds(double)
String	toString() String representation.

Methods inherited from class ucar.nc2.units.SimpleUnit

convertTo, factory, factoryWithExceptions, getCanonicalString, getConversionFactor, getImplementingClass, getUnit, isCompatible, isCompatible, isCompatibleWithExceptions, isDateUnit, isDateUnit, isTimeUnit, isTimeUnit, isUnknownUnit, makeUnit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeUnit

public TimeUnit(String text)
         throws ucar.units.UnitException

Constructor from a String.

Parameters:

text - [value] eg "hours" or "13 hours". Time unit is from udunits.

Throws:

ucar.units.UnitException - if bad format

TimeUnit

public TimeUnit(double value,
                String unitString)
         throws ucar.units.UnitException

Constructor from a value and a unit name.

Parameters:

value - amount of the unit.

unitString - Time unit string from udunits.

Throws:

ucar.units.UnitException - if parse fails

TimeUnit

public TimeUnit(TimeUnit src)

Copy Constructor.

Parameters:

src - copy from here

Method Detail

getValue

public double getValue()

Get the value.

Overrides:

getValue in class SimpleUnit

Returns:

value of this unit if ScaledUnit, else NaN

getFactor

public double getFactor()

Get the factor that converts this unit to seconds. getValueInSeconds = factor * value

Returns:

factor that converts this unit to seconds.

setValue

@Deprecated
public void setValue(double value)

Deprecated. use newValue(double)

Set the value in the original units.

Parameters:

value - set value, must be in units of this

newValue

public TimeUnit newValue(double value)

Create a new TimeUnit with the given value.

getUnitString

public String getUnitString()

Get the "base" unit String, eg "secs" or "days"

Overrides:

getUnitString in class SimpleUnit

Returns:

unit string with no value

toString

public String toString()

String representation.

Overrides:

toString in class SimpleUnit

getValueInSeconds

public double getValueInSeconds()

Get the time duration in seconds.

Returns:

get current value in units of seconds

getValueInSeconds

public double getValueInSeconds(double value)

Get the time duration in seconds of the specified value.

Parameters:

value - convert this value, must be in units of this

Returns:

get the value in units of seconds

setValueInSeconds

@Deprecated
public void setValueInSeconds(double secs)

Deprecated. use newValueInSeconds(double)

Set the value, using the given number of seconds.

Parameters:

secs - : number of seconds; convert this to the units of this TimeUnit.

newValueInSeconds

public TimeUnit newValueInSeconds(double secs)

Create a new TimeUnit with the given value in seconds.

convertTo

public double convertTo(double value,
                        TimeUnit outputUnit)
                 throws ucar.units.ConversionException

Convert given value of this unit to the new unit. NOTE: the current value of this unit ignored, the given value is used instead. This is different than ucar.units or SimpleUnit.

Parameters:

value - in the units of this "base unit"

outputUnit - convert to this base type, must be convertible to units of "seconds"

Returns:

new value in the units of the "outputUnit

Throws:

ucar.units.ConversionException

add

@Deprecated
public Date add(Date d)

Deprecated. use add(CalendarDate)

Add the time amount to the given Date, return a new Date.

Parameters:

d - add to this Date

Returns:

Date with getValueInSeconds() added to it.

add

public CalendarDate add(CalendarDate cd)

Add the time amount to the given Date, return a new Date.

Parameters:

cd - add to this CalendarDate

Returns:

CalendarDate with getValueInSeconds() added to it.

equals

public boolean equals(Object o)

TimeUnits with same value and unitString are equal

Overrides:

equals in class Object

hashCode

public int hashCode()

Override hashcode to be consistent with equals.

Overrides:

hashCode in class Object