gov.nasa.gsfc.spdf.cdfj

Interface TimeVariable

All Known Subinterfaces:

TimeVariableX

All Known Implementing Classes:

TimeVariableFactory.CDFEpoch16Variable, TimeVariableFactory.CDFEpochVariable, TimeVariableFactory.CDFTimeVariable, TimeVariableFactory.CDFTT2000Variable, TimeVariableFactory.UnixTimeVariable

public interface TimeVariable

Time Variable.

Method Summary

Modifier and Type	Method and Description
boolean	canSupportPrecision(TimePrecision tp) Returns whether the given precision is available for this variable.
double	getFirstMilliSecond() Returns the millisecond offset of the first record using Epoch 0 as the base time
java.lang.String	getName() Returns name of the variable.
TimePrecision	getPrecision() Returns time precision of the variable.
int[]	getRecordRange(int[] startTime, int[] stopTime) Returns range of records which fall within the specified range of times relative to the base of the given time instant model.
double[]	getTimes() Returns relative times using the default time instant model.
double[]	getTimes(int[] recordRange) Returns relative times for the specified record range using the default time instant model.
double[]	getTimes(int[] startTime, int[] stopTime) Returns relative times for the specified time range using the default time instant model.
double[]	getTimes(int[] startTime, int[] stopTime, TimeInstantModel tspec) Returns relative times for the specified time range using the given time instant model.
double[]	getTimes(int[] recordRange, TimeInstantModel tspec) Returns relative times for the specified record range using the specified time instant model.
double[]	getTimes(TimeInstantModel tspec) Returns relative times using the specified time instant model.
boolean	isTT2000() Returns whether this is a TT2000 type variable

Method Detail

getName

java.lang.String getName()

Returns name of the variable.

Returns:

getPrecision

TimePrecision getPrecision()

Returns time precision of the variable.

Returns:

getTimes

double[] getTimes()

Returns relative times using the default time instant model.

Returns:

getTimes

double[] getTimes(TimeInstantModel tspec)
           throws java.lang.Throwable

Returns relative times using the specified time instant model.

Parameters:

tspec -

Returns:

Throws:

java.lang.Throwable

getTimes

double[] getTimes(int[] recordRange)
           throws java.lang.Throwable

Returns relative times for the specified record range using the default time instant model.

Parameters:

recordRange -

Returns:

Throws:

java.lang.Throwable

getTimes

double[] getTimes(int[] recordRange,
                  TimeInstantModel tspec)
           throws java.lang.Throwable

Returns relative times for the specified record range using the specified time instant model.

Parameters:

recordRange -

tspec -

Returns:

Throws:

java.lang.Throwable

getTimes

double[] getTimes(int[] startTime,
                  int[] stopTime)
           throws java.lang.Throwable

Returns relative times for the specified time range using the default time instant model.

Parameters:

startTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

stopTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

Returns:

Throws:

java.lang.Throwable

getTimes

double[] getTimes(int[] startTime,
                  int[] stopTime,
                  TimeInstantModel tspec)
           throws java.lang.Throwable

Returns relative times for the specified time range using the given time instant model.

Parameters:

startTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

stopTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

tspec -

Returns:

Throws:

java.lang.Throwable

getRecordRange

int[] getRecordRange(int[] startTime,
                     int[] stopTime)
              throws java.lang.Throwable

Returns range of records which fall within the specified range of times relative to the base of the given time instant model.

Parameters:

startTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

stopTime - a 3 to 7 element int[], containing year, month, day,hour, minute, second and millisecond.

Returns:

Throws:

java.lang.Throwable

getFirstMilliSecond

double getFirstMilliSecond()

Returns the millisecond offset of the first record using Epoch 0 as the base time

This number may be useful as a base time for a time instant model when looking at high time resolution data.

Returns:

isTT2000

boolean isTT2000()

Returns whether this is a TT2000 type variable

Returns:

canSupportPrecision

boolean canSupportPrecision(TimePrecision tp)

Returns whether the given precision is available for this variable.

Parameters:

tp -

Returns:

false if the required precision is finer than this variable's resolution. Thus, for a variable of type EPOCH, this method will return false for microsecond, or finer resolution.