CoordinateTime2D (grib 5.0.0-alpha2 API)

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. isOrthogonal means all time coordinate offsets are the same for each runtime. isRegular means all time coordinate offsets are the same for each "runtime hour of day" (from FMRC).

Since:

1/22/14

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

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

Field Summary
- Fields inherited from class ucar.coord.CoordinateTimeAbstract
  cdf, code, MIXED_INTERVALS, name, periodName, refDate, time2runtime, timeUnit

Constructor Summary

Constructors
Constructor and Description
`CoordinateTime2D(int code, ucar.nc2.time.CalendarPeriod timeUnit, java.util.List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, CoordinateTimeAbstract otime, java.util.List<Coordinate> times, int[] time2runtime)` Ctor.
`CoordinateTime2D(int code, ucar.nc2.time.CalendarPeriod timeUnit, java.util.List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, java.util.List<Coordinate> times, int[] time2runtime)` Ctor.
`CoordinateTime2D(int code, ucar.nc2.time.CalendarPeriod timeUnit, java.util.List<CoordinateTime2D.Time2D> vals, CoordinateRuntime runtime, java.util.List<Coordinate> regList, java.util.List<Coordinate> times, int[] time2runtime)` Ctor.

Method Summary

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

Methods inherited from class ucar.coord.CoordinateTimeAbstract
getCode, getMasterRuntimeIndex, getName, getOffsetInTimeUnits, getRefDate, getTime2runtime, getTimeUdUnit, getTimeUnit, getUnit, makeBestFromComplete

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,
                        ucar.nc2.time.CalendarPeriod timeUnit,
                        java.util.List<CoordinateTime2D.Time2D> vals,
                        CoordinateRuntime runtime,
                        java.util.List<Coordinate> times,
                        int[] time2runtime)
```
    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,
                        ucar.nc2.time.CalendarPeriod timeUnit,
                        java.util.List<CoordinateTime2D.Time2D> vals,
                        CoordinateRuntime runtime,
                        CoordinateTimeAbstract otime,
                        java.util.List<Coordinate> times,
                        int[] time2runtime)
```
    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,
                        ucar.nc2.time.CalendarPeriod timeUnit,
                        java.util.List<CoordinateTime2D.Time2D> vals,
                        CoordinateRuntime runtime,
                        java.util.List<Coordinate> regList,
                        java.util.List<Coordinate> times,
                        int[] time2runtime)
```
    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
  - setName
```
public void setName(java.lang.String name)
```
    Overrides:
    
    setName in class CoordinateTimeAbstract
  - 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(java.util.Formatter info,
                     ucar.nc2.util.Indent indent)
```
    Specified by:
    
    showInfo in interface Coordinate
  - showCoords
```
public void showCoords(java.util.Formatter info)
```
    Specified by:
    
    showCoords in interface Coordinate
  - calcDistributions
```
public ucar.nc2.util.Counters calcDistributions()
```
    Specified by:
    
    calcDistributions in interface Coordinate
  - getValues
```
public java.util.List<? extends java.lang.Object> getValues()
```
    Specified by:
    
    getValues in interface Coordinate
  - getValue
```
public java.lang.Object getValue(int idx)
```
    Specified by:
    
    getValue in interface Coordinate
  - getIndex
```
public int getIndex(java.lang.Object val)
```
    Specified by:
    
    getIndex in interface Coordinate
  - getSize
```
public int getSize()
```
    Specified by:
    
    getSize in interface Coordinate
  - getNCoords
```
public int getNCoords()
```
    Specified by:
    
    getNCoords in interface Coordinate
    
    Overrides:
    
    getNCoords in class CoordinateTimeAbstract
  - 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(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getTimeIntervalName
```
public java.lang.String getTimeIntervalName()
```
    Check if all time intervals have the same length. Only if isTimeInterval.
    
    Returns:
    
    time interval name or MIXED_INTERVALS
  - makeCalendarDateRange
```
public ucar.nc2.time.CalendarDateRange makeCalendarDateRange(ucar.nc2.time.Calendar cal)
```
    Specified by:
    
    makeCalendarDateRange in class CoordinateTimeAbstract
  - getTimeCoordinate
```
public CoordinateTimeAbstract getTimeCoordinate(int runIdx)
```
  - getRefDate
```
public ucar.nc2.time.CalendarDate getRefDate(int runIdx)
```
  - getRuntime
```
public long getRuntime(int runIdx)
```
  - getOrgValue
```
public CoordinateTime2D.Time2D getOrgValue(int runIdx,
                                           int timeIdx)
```
    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,
                               CoordinateTime2D.Time2D value)
```
    Find the index matching a runtime and time coordinate
    
    Parameters:
    
    runIdx - which run
    
    value - 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
  - makeTime2Runtime
```
public CoordinateTimeAbstract makeTime2Runtime(CoordinateRuntime master)
```
  - makeBestTimeCoordinate
```
public CoordinateTimeAbstract makeBestTimeCoordinate(CoordinateRuntime master)
```
  - hasUniqueTimes
```
public boolean hasUniqueTimes()
```
  - getTimeIndicesFromMrutp
```
public int[] getTimeIndicesFromMrutp(int timeIdx)
```
  - getTimesForSerialization
```
public java.util.List<? extends Coordinate> getTimesForSerialization()
```
    public by accident - do not use
  - findTimeIndexFromVal
```
public int findTimeIndexFromVal(int runIdx,
                                java.lang.Object val)
```
    Find index in time coordinate from the time value
    
    Parameters:
    
    val - TimeCoord.Tinv or Integer
    
    Returns:
    
    indx in the time coordinate
  - getOffsetsSorted
```
public java.util.List<? extends java.lang.Object> getOffsetsSorted()
```
    Get a sorted list of the unique time coordinates
    
    Returns:
    
    List or List

Class CoordinateTime2D

Nested Class Summary

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

Field Summary

Fields inherited from class ucar.coord.CoordinateTimeAbstract

Constructor Summary

Method Summary

Methods inherited from class ucar.coord.CoordinateTimeAbstract

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.coord.Coordinate

Constructor Detail

CoordinateTime2D

CoordinateTime2D

CoordinateTime2D

Method Detail

setName

getRuntimeCoordinate

isTimeInterval

isOrthogonal

isRegular

getNtimes

getNruns

getOffset

showInfo

showCoords

calcDistributions

getValues

getValue

getIndex

getSize

getNCoords

estMemorySize

getType

equals

hashCode

getTimeIntervalName

makeCalendarDateRange

getTimeCoordinate

getRefDate

getRuntime

getOrgValue

getIndex

matchTimeCoordinate

makeBestFromComplete

makeTime2Runtime

makeBestTimeCoordinate

hasUniqueTimes

getTimeIndicesFromMrutp

getTimesForSerialization

findTimeIndexFromVal

getOffsetsSorted