ucar.nc2.grid

Class GridAxis1DTime

java.lang.Object

ucar.nc2.grid.GridAxis

ucar.nc2.grid.GridAxis1D

ucar.nc2.grid.GridAxis1DTime

All Implemented Interfaces:

Iterable<Object>

@Immutable
public class GridAxis1DTime
extends GridAxis1D

A 1-dimensional GridAxis whose coordinates can be converted to CalendarDates. A GridAxis1DTime has a CalendarDateUnit that allows converting between doubles and CalendarDates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridAxis1DTime.Builder<T extends GridAxis1DTime.Builder<T>>

Nested classes/interfaces inherited from class ucar.nc2.grid.GridAxis

GridAxis.DependenceType, GridAxis.Spacing

Field Summary

Fields inherited from class ucar.nc2.grid.GridAxis

attributes, axisType, dependenceType, dependsOn, description, isSubset, name, resolution, spacing, units

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridAxis1DTime(GridAxis1DTime.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
protected GridAxis1DTime.Builder<?>	addLocalFieldsToBuilder(GridAxis1DTime.Builder<? extends GridAxis1DTime.Builder<?>> b)
static CalendarDate	addOffset(CalendarDate runDate, double offset, String offsetUnits) Get the time from the runtime and offset
static GridAxis1DTime.Builder<?>	builder()
static GridAxis1DTime.Builder<?>	builder(VariableDS vds) A builder taking fields from a VariableDS
boolean	equals(Object o)
int	findTimeIndexFromCalendarDate(CalendarDate d) Given a Date, find the corresponding time index on the time coordinate axis.
Calendar	getCalendar() Get the Calendar used by this axis.
CalendarDate	getCalendarDate(int idx) Get the the ith coordinate CalendarDate.
CalendarDateRange	getCalendarDateRange() Get the calendar date range
com.google.common.collect.ImmutableList<CalendarDate>	getCalendarDates() Get the list of coordinates as CalendarDates.
CalendarDateUnit	getCalendarDateUnit() Get the CalendarDateUnit
CalendarDate[]	getCoordBoundsDate(int i) Get the bounds of the ith coordinate as a CalendarDate[2].
CalendarDate	getCoordBoundsMidpointDate(int i) Get the midpoint of the ith coordinate as a CalendarDate.
double	getOffsetInTimeUnits(CalendarDate start, CalendarDate end) Use the CalendarDateUnit to find the difference between two CalendarDates.
CalendarDate	getRefDate() Get Reference Date of the CalendarDateUnit (not the runtime)
String	getSummary()
TimeHelper	getTimeHelper()
boolean	hasCalendarDate(CalendarDate date) See if the given CalendarDate appears as a coordinate
int	hashCode()
CalendarDate	makeDate(double value) Use the CalendarDateUnit to make a CalendarDate from a value.
CalendarDate	makeDateInTimeUnits(CalendarDate start, double addTo) Use the CalendarDateUnit to add a value to the given CalendarDate.
double	makeValue(CalendarDate date) Use the CalendarDateUnit to make a value from a CalendarDate.
GridAxis	subset(GridSubset params, Formatter errLog) Create a subset of this axis based on the SubsetParams.
GridAxis1DTime.Builder<?>	toBuilder()
void	toString(Formatter f, Indent indent)

Methods inherited from class ucar.nc2.grid.GridAxis1D

addLocalFieldsToBuilder, getCoordBoundsAsArray, getCoordEdge1, getCoordEdge2, getCoordEdgeMinMax, getCoordInterval, getCoordMidpoint, getCoordsAsArray, getEndValue, getNcoords, getRange, getRangeIterator, getStartValue, getValues, isAscending, iterator, subsetDependent

Methods inherited from class ucar.nc2.grid.GridAxis

addLocalFieldsToBuilder, attributes, compareTo, getAxisType, getDependenceType, getDependsOn, getDescription, getName, getResolution, getSpacing, getUnits, isInterval, isRegular, isSubset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GridAxis1DTime

protected GridAxis1DTime(GridAxis1DTime.Builder<?> builder)

Method Detail

getCalendarDates

public com.google.common.collect.ImmutableList<CalendarDate> getCalendarDates()

Get the list of coordinates as CalendarDates.

getCalendarDate

public CalendarDate getCalendarDate(int idx)

Get the the ith coordinate CalendarDate.

getCalendarDateRange

public CalendarDateRange getCalendarDateRange()

Get the calendar date range

makeValue

public double makeValue(CalendarDate date)

Use the CalendarDateUnit to make a value from a CalendarDate.

getTimeHelper

public TimeHelper getTimeHelper()

findTimeIndexFromCalendarDate

public int findTimeIndexFromCalendarDate(CalendarDate d)

Given a Date, find the corresponding time index on the time coordinate axis. This will return

• i, if time(i) <= d < time(i+1).
• 0, if d < time(0)
• n-1, if d > time(n-1), where n is length of time coordinates

Parameters:

d - date to look for

Returns:

corresponding time index on the time coordinate axis

hasCalendarDate

public boolean hasCalendarDate(CalendarDate date)

See if the given CalendarDate appears as a coordinate

getCoordBoundsDate

public CalendarDate[] getCoordBoundsDate(int i)

Get the bounds of the ith coordinate as a CalendarDate[2].

getCoordBoundsMidpointDate

public CalendarDate getCoordBoundsMidpointDate(int i)

Get the midpoint of the ith coordinate as a CalendarDate.

addOffset

public static CalendarDate addOffset(CalendarDate runDate,
                                     double offset,
                                     String offsetUnits)

Get the time from the runtime and offset

getCalendarDateUnit

public CalendarDateUnit getCalendarDateUnit()

Get the CalendarDateUnit

getRefDate

public CalendarDate getRefDate()

Get Reference Date of the CalendarDateUnit (not the runtime)

getOffsetInTimeUnits

public double getOffsetInTimeUnits(CalendarDate start,
                                   CalendarDate end)

Use the CalendarDateUnit to find the difference between two CalendarDates.

makeDateInTimeUnits

public CalendarDate makeDateInTimeUnits(CalendarDate start,
                                        double addTo)

Use the CalendarDateUnit to add a value to the given CalendarDate.

getCalendar

public Calendar getCalendar()

Get the Calendar used by this axis.

makeDate

public CalendarDate makeDate(double value)

Use the CalendarDateUnit to make a CalendarDate from a value.

subset

@Nullable
public GridAxis subset(GridSubset params,
                                  Formatter errLog)

Description copied from class: GridAxis

Create a subset of this axis based on the SubsetParams.

Overrides:

subset in class GridAxis1D

getSummary

public String getSummary()

Overrides:

getSummary in class GridAxis1D

toString

public void toString(Formatter f,
                     Indent indent)

Overrides:

toString in class GridAxis1D

equals

public boolean equals(Object o)

Overrides:

equals in class GridAxis1D

hashCode

public int hashCode()

Overrides:

hashCode in class GridAxis1D

toBuilder

public GridAxis1DTime.Builder<?> toBuilder()

Overrides:

toBuilder in class GridAxis1D

addLocalFieldsToBuilder

protected GridAxis1DTime.Builder<?> addLocalFieldsToBuilder(GridAxis1DTime.Builder<? extends GridAxis1DTime.Builder<?>> b)

builder

public static GridAxis1DTime.Builder<?> builder(VariableDS vds)

A builder taking fields from a VariableDS

builder

public static GridAxis1DTime.Builder<?> builder()