ucar.nc2.grib

Class TimeCoord

java.lang.Object

ucar.nc2.grib.TimeCoord

Direct Known Subclasses:

TimeCoordUnion

@Immutable
public class TimeCoord
extends Object

Generalized Time Coordinate. Can handle

1. "n unit since refDate"
2. "Date"
3. interval (start,end) using "n unit since refDate"
4. interval (startDate, endDate)

Since:

3/30/11

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeCoord.Tinv
static class	TimeCoord.TinvDate

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	coords
protected List<TimeCoord.Tinv>	intervals

Constructor Summary

Constructors

Constructor and Description
TimeCoord(int code, CalendarDate runDate, CalendarPeriod timeUnit, List coords)
TimeCoord(int code, String udunitString, List coords)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equalsData(TimeCoord tother) Instances that have the same runtime, timeUnit and coordinates are equal
static int	findCoord(List<TimeCoord> timeCoords, TimeCoord want) Look through timeCoords to see if one matches want.
int	findIdx(int offsetHour)
int	findInterval(TimeCoord.Tinv tinv)
static int	getCalendarOffset(CalendarDate refDate, CalendarDate cd, CalendarPeriod timeUnit)
CalendarDateRange	getCalendarRange()
int	getCode()
List<Integer>	getCoords()
List<TimeCoord.Tinv>	getIntervals()
String	getName()
static int	getOffset(CalendarDate refDate, CalendarDate cd, CalendarPeriod timeUnit)
CalendarDate	getRunDate()
int	getSize()
String	getTimeIntervalName()
CalendarPeriod	getTimeUnit()
double	getTimeUnitScale()
String	getType()
String	getUnits()
boolean	isInterval()
TimeCoord	setIndex(int index)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

coords

protected List<Integer> coords

intervals

protected List<TimeCoord.Tinv> intervals

Constructor Detail

TimeCoord

public TimeCoord(int code,
         String udunitString,
         List coords)

TimeCoord

public TimeCoord(int code,
         CalendarDate runDate,
         CalendarPeriod timeUnit,
         List coords)

Method Detail

getOffset

public static int getOffset(CalendarDate refDate,
            CalendarDate cd,
            CalendarPeriod timeUnit)

getCalendarOffset

public static int getCalendarOffset(CalendarDate refDate,
                    CalendarDate cd,
                    CalendarPeriod timeUnit)

setIndex

public TimeCoord setIndex(int index)

getRunDate

public CalendarDate getRunDate()

getCalendarRange

public CalendarDateRange getCalendarRange()

isInterval

public boolean isInterval()

getCoords

public List<Integer> getCoords()

getIntervals

public List<TimeCoord.Tinv> getIntervals()

getUnits

public String getUnits()

getTimeUnitScale

public double getTimeUnitScale()

getTimeUnit

public CalendarPeriod getTimeUnit()

getCode

public int getCode()

getName

public String getName()

getType

public String getType()

getSize

public int getSize()

getTimeIntervalName

public String getTimeIntervalName()

toString

public String toString()

Overrides:

toString in class Object

equalsData

public boolean equalsData(TimeCoord tother)

Instances that have the same runtime, timeUnit and coordinates are equal

Parameters:

tother - compare this TimeCoord's data

Returns:

true if data are equal

findInterval

public int findInterval(TimeCoord.Tinv tinv)

findIdx

public int findIdx(int offsetHour)

findCoord

public static int findCoord(List<TimeCoord> timeCoords,
            TimeCoord want)

Look through timeCoords to see if one matches want. Matches means equalsData() is true. If not found, make a new one and add to timeCoords.

Parameters:

timeCoords - look through this list

want - find equivilent

Returns:

return equivilent or make a new one and add to timeCoords