ucar.coord

Class CoordinateTime2D

java.lang.Object

ucar.coord.CoordinateTimeAbstract

ucar.coord.CoordinateTime2D

All Implemented Interfaces:

Coordinate

@Immutable
public class CoordinateTime2D
extends CoordinateTimeAbstract
implements Coordinate

Both runtime and time coordinates are tracked here. The time coordinate is dependent on the runtime, at least on the offset.

Since:

1/22/14

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinateTime2D.Builder1
static class	CoordinateTime2D.Builder2
static class	CoordinateTime2D.Time2D

Nested classes/interfaces inherited from interface ucar.coord.Coordinate

Coordinate.Type

Field Summary

Fields inherited from class ucar.coord.CoordinateTimeAbstract

code, MIXED_INTERVALS, name, periodName, refDate, time2runtime, timeUnit

Constructor Summary

Constructors

Constructor and Description
CoordinateTime2D(int code, CalendarPeriod timeUnit, List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, CoordinateTimeAbstract otime, List<Coordinate> times) Ctor.
CoordinateTime2D(int code, CalendarPeriod timeUnit, List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, List<Coordinate> times) Ctor.
CoordinateTime2D(int code, CalendarPeriod timeUnit, List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, List<Coordinate> regList, List<Coordinate> times) Ctor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	estMemorySize()
boolean	getIndex(CoordinateTime2D.Time2D want, int[] wholeIndex) find the run and time indexes of want the inverse of getOrgValue
int	getIndex(Object val)
int	getNruns()
int	getNtimes()
int	getOffset(int runIndex)
List<? extends Object>	getOffsetsSorted() Get a sorted list of the unique time coordinates
CoordinateTime2D.Time2D	getOrgValue(int runIdx, int timeIdx, boolean debug) Get the time coordinate at the given indices, into the 2D time coordinate array
CalendarDate	getRefDate(int runIdx)
long	getRuntime(int runIdx)
CoordinateRuntime	getRuntimeCoordinate()
int	getSize()
CoordinateTimeAbstract	getTimeCoordinate(int runIdx)
String	getTimeIntervalName() Check if all time intervals have the same length.
List<? extends Coordinate>	getTimesForSerialization() public by accident - do not use
Coordinate.Type	getType()
Object	getValue(int idx)
List<? extends Object>	getValues()
int	hashCode()
boolean	isOrthogonal()
boolean	isRegular()
boolean	isTimeInterval()
protected CoordinateTimeAbstract	makeBestFromComplete(int[] best, int n)
CoordinateTimeAbstract	makeBestTimeCoordinate(CoordinateRuntime master)
CalendarDateRange	makeCalendarDateRange(Calendar cal)
int	matchTimeCoordinate(int runIdx, Object value, CalendarDate refDateOfValue) Find the index matching a runtime and time coordinate
void	showCoords(Formatter info)
void	showInfo(Formatter info, Indent indent)

Methods inherited from class ucar.coord.CoordinateTimeAbstract

getCode, getMasterRuntimeIndex, getName, getPeriod, getRefDate, getTime2runtime, getTimeUnit, getTimeUnitScale, getUnit, makeBestFromComplete, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.coord.Coordinate

getCode, getName, getUnit

Constructor Detail

CoordinateTime2D

public CoordinateTime2D(int code,
                CalendarPeriod timeUnit,
                List<CoordinateTime2D.Time2D> vals,
                CoordinateRuntime runtime,
                List<Coordinate> times)

Ctor. Most general, a CoordinateTime for each runtime.

Parameters:

code - pdsFirst.getTimeUnit()

timeUnit - time duration, based on code

vals - complete set of Time2D values, may be null (used only during creation)

runtime - list of runtimes

times - list of times, one for each runtime, offsets reletive to its runtime, may not be null

CoordinateTime2D

public CoordinateTime2D(int code,
                CalendarPeriod timeUnit,
                List<CoordinateTime2D.Time2D> vals,
                CoordinateRuntime runtime,
                CoordinateTimeAbstract otime,
                List<Coordinate> times)

Ctor. orthogonal - all offsets are the same for all runtimes, so 2d time array is (runtime X otime)

Parameters:

code - pdsFirst.getTimeUnit()

timeUnit - time duration, based on code

vals - complete set of Time2D values, may be null (used only during creation)

runtime - list of runtimes

otime - list of offsets, all the same for each runtime

times - list of times, one for each runtime, offsets reletive to its runtime, may be null (Only available during creation, not stored in index)

CoordinateTime2D

public CoordinateTime2D(int code,
                CalendarPeriod timeUnit,
                List<CoordinateTime2D.Time2D> vals,
                CoordinateRuntime runtime,
                List<Coordinate> regList,
                List<Coordinate> times)

Ctor. regular - all offsets are the same for each "runtime hour of day", eg all 0Z runtimes have the same offsets, all 6Z runtimes have the same offsets, etc. 2d time array is (runtime X otime(hour), where hour = runtime hour of day

Parameters:

code - pdsFirst.getTimeUnit()

timeUnit - time duration, based on code

vals - complete set of Time2D values, may be null (used only during creation)

runtime - list of runtimes

regList - list of offsets, one each for each possible runtime hour of day.

times - list of times, one for each runtime, offsets reletive to its runtime, may be null (Only available during creation, not stored in index)

Method Detail

getRuntimeCoordinate

public CoordinateRuntime getRuntimeCoordinate()

isTimeInterval

public boolean isTimeInterval()

isOrthogonal

public boolean isOrthogonal()

isRegular

public boolean isRegular()

getNtimes

public int getNtimes()

getNruns

public int getNruns()

getOffset

public int getOffset(int runIndex)

showInfo

public void showInfo(Formatter info,
            Indent indent)

Specified by:

showInfo in interface Coordinate

showCoords

public void showCoords(Formatter info)

Specified by:

showCoords in interface Coordinate

getValues

public List<? extends Object> getValues()

Specified by:

getValues in interface Coordinate

getValue

public Object getValue(int idx)

Specified by:

getValue in interface Coordinate

getIndex

public int getIndex(Object val)

Specified by:

getIndex in interface Coordinate

getSize

public int getSize()

Specified by:

getSize in interface Coordinate

estMemorySize

public int estMemorySize()

Specified by:

estMemorySize in interface Coordinate

getType

public Coordinate.Type getType()

Specified by:

getType in interface Coordinate

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTimeIntervalName

public String getTimeIntervalName()

Check if all time intervals have the same length. Only if isTimeInterval.

Returns:

time interval name or MIXED_INTERVALS

makeCalendarDateRange

public CalendarDateRange makeCalendarDateRange(Calendar cal)

Specified by:

makeCalendarDateRange in class CoordinateTimeAbstract

getTimeCoordinate

public CoordinateTimeAbstract getTimeCoordinate(int runIdx)

getRefDate

public CalendarDate getRefDate(int runIdx)

getRuntime

public long getRuntime(int runIdx)

getOrgValue

public CoordinateTime2D.Time2D getOrgValue(int runIdx,
                                  int timeIdx,
                                  boolean debug)

Get the time coordinate at the given indices, into the 2D time coordinate array

Parameters:

runIdx - run index

timeIdx - time index

Returns:

time coordinate

getIndex

public boolean getIndex(CoordinateTime2D.Time2D want,
               int[] wholeIndex)

find the run and time indexes of want the inverse of getOrgValue

Parameters:

want - find time coordinate that matches

wholeIndex - return index here

matchTimeCoordinate

public int matchTimeCoordinate(int runIdx,
                      Object value,
                      CalendarDate refDateOfValue)

Find the index matching a runtime and time coordinate

Parameters:

runIdx - which run

value - time coordinate

refDateOfValue - reference time of time coordinate

Returns:

index in the time coordinate of the value

makeBestFromComplete

protected CoordinateTimeAbstract makeBestFromComplete(int[] best,
                                          int n)

Specified by:

makeBestFromComplete in class CoordinateTimeAbstract

makeBestTimeCoordinate

public CoordinateTimeAbstract makeBestTimeCoordinate(CoordinateRuntime master)

getTimesForSerialization

public List<? extends Coordinate> getTimesForSerialization()

public by accident - do not use

getOffsetsSorted

public List<? extends Object> getOffsetsSorted()

Get a sorted list of the unique time coordinates

Returns:

List or List