gov.nasa.gsfc.spdf.cdfj

Class TimeVariableFactory.CDFTimeVariable

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.TimeVariableFactory.CDFTimeVariable

All Implemented Interfaces:

TimeVariable, TimeVariableX

Direct Known Subclasses:

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

Enclosing class:

TimeVariableFactory

public abstract static class TimeVariableFactory.CDFTimeVariable
extends java.lang.Object
implements TimeVariableX

Method Summary

Modifier and Type	Method and Description
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.
java.nio.ByteBuffer	getRawBuffer()
int[]	getRecordRange(double[] timeRange)
int[]	getRecordRange(double[] timeRange, TimeInstantModel ts)
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.
int[]	getRecordRange(int[] startTime, int[] stopTime, TimeInstantModel ts)
double[]	getTimes() Returns relative times using the default time instant model.
double[]	getTimes(double[] timeRange)
double[]	getTimes(double[] timeRange, TimeInstantModel ts) Returns relative times for the specified time range using the given 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 ts) Returns relative times for the specified time range using the given time instant model.
double[]	getTimes(int[] recordRange, TimeInstantModel ts) Returns relative times for the specified record range using the specified time instant model.
double[]	getTimes(TimeInstantModel ts) Returns relative times using the specified time instant model.
abstract boolean	isTT2000() Returns whether this is a TT2000 type variable
protected void	setRecordCount(int count)

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nasa.gsfc.spdf.cdfj.TimeVariable

canSupportPrecision

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TimeVariable

Returns name of the variable.

Specified by:

getName in interface TimeVariable

Returns:

getPrecision

public TimePrecision getPrecision()

Description copied from interface: TimeVariable

Returns time precision of the variable.

Specified by:

getPrecision in interface TimeVariable

Specified by:

getPrecision in interface TimeVariableX

Returns:

getTimes

public double[] getTimes()

Description copied from interface: TimeVariable

Returns relative times using the default time instant model.

Specified by:

getTimes in interface TimeVariable

Returns:

getTimes

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

Description copied from interface: TimeVariable

Returns relative times using the specified time instant model.

Specified by:

getTimes in interface TimeVariable

Returns:

Throws:

java.lang.Throwable

getTimes

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

Description copied from interface: TimeVariable

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

Specified by:

getTimes in interface TimeVariable

Returns:

Throws:

java.lang.Throwable

getTimes

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

Description copied from interface: TimeVariable

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

Specified by:

getTimes in interface TimeVariable

Returns:

Throws:

java.lang.Throwable

getTimes

public double[] getTimes(double[] timeRange)

Parameters:

timeRange -

Returns:

getTimes

public double[] getTimes(double[] timeRange,
                         TimeInstantModel ts)
                  throws java.lang.Throwable

Description copied from interface: TimeVariableX

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

Specified by:

getTimes in interface TimeVariableX

Parameters:

timeRange - relative time range

Returns:

Throws:

java.lang.Throwable

getTimes

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

Description copied from interface: TimeVariable

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

Specified by:

getTimes in interface TimeVariable

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

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

Description copied from interface: TimeVariable

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

Specified by:

getTimes in interface TimeVariable

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

getRecordRange

public int[] getRecordRange(double[] timeRange)
                     throws java.lang.Throwable

Specified by:

getRecordRange in interface TimeVariableX

Parameters:

timeRange -

Returns:

Throws:

java.lang.Throwable

getRecordRange

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

Description copied from interface: TimeVariable

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

Specified by:

getRecordRange in interface TimeVariable

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

getRecordRange

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

Specified by:

getRecordRange in interface TimeVariableX

Parameters:

startTime -

stopTime -

ts -

Returns:

Throws:

java.lang.Throwable

getRecordRange

public int[] getRecordRange(double[] timeRange,
                            TimeInstantModel ts)
                     throws java.lang.Throwable

Parameters:

timeRange -

ts -

Returns:

Throws:

java.lang.Throwable

setRecordCount

protected void setRecordCount(int count)

Parameters:

count -

getFirstMilliSecond

public double getFirstMilliSecond()

Description copied from interface: TimeVariable

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.

Specified by:

getFirstMilliSecond in interface TimeVariable

Returns:

isTT2000

public abstract boolean isTT2000()

Description copied from interface: TimeVariable

Returns whether this is a TT2000 type variable

Specified by:

isTT2000 in interface TimeVariable

Returns:

getRawBuffer

public java.nio.ByteBuffer getRawBuffer()

Specified by:

getRawBuffer in interface TimeVariableX

Returns: