TimeExtent (SensorHub Build 1.1.0 API)

java.lang.Object
- org.vast.util.TimeExtent

```
public class TimeExtent
extends Object
```
Class for storing the definition of a temporal domain. This can include a base time, time bias (deviation from base time), time step, and lead/lag time deltas.

Since:

Nov 15, 2005

Author:

Tony Cook, Mike Botts, Alexandre Robin

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`baseAtNow`
`protected double`	`baseTime`
`protected boolean`	`beginNow`
`protected boolean`	`endNow`
`protected double`	`lagTimeDelta`
`protected double`	`leadTimeDelta`
`static double`	`NOW`
`static double`	`NOW_ACCURACY`
`protected double`	`timeBias`
`protected double`	`timeStep`
`protected int`	`timeZone`
`static double`	`UNKNOWN`

Constructor Summary

Constructors
Constructor and Description
`TimeExtent()`
`TimeExtent(double baseJulianTime)`
`TimeExtent(double startTime, double stopTime)`
`TimeExtent(double baseJulianTime, double timeBiasSeconds, double timeStepSeconds, double leadTimeDeltaSeconds, double lagTimeDeltaSeconds)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(double time)` Checks if this TimeExtent contains the given time
`boolean`	`contains(TimeExtent timeExtent)` Checks if this TimeExtent contains the given TimeExtent
`TimeExtent`	`copy()`
`boolean`	`equals(Object obj)`
`boolean`	`equals(TimeExtent timeExtent)` Checks if time extents are equal (no null check) (i.e.
`double`	`getAdjustedLagTime()`
`double`	`getAdjustedLeadTime()`
`double`	`getAdjustedTime()` To get baseTime or absTime with bias applied
`double`	`getBaseTime()` To get baseTime without bias applied.
`String`	`getIsoString(int zone)`
`double`	`getLagTimeDelta()`
`double`	`getLeadTimeDelta()`
`static TimeExtent`	`getNowInstant()`
`int`	`getNumberOfSteps()`
`static TimeExtent`	`getPeriodEndingNow(double startTime)`
`static TimeExtent`	`getPeriodStartingNow(double stopTime)`
`double`	`getStartTime()` Helper method to get start time
`double`	`getStopTime()` Helper method to get stop time
`double`	`getTimeBias()`
`double`	`getTimeRange()`
`double[]`	`getTimes()` Calculates times based on current time settings, always assuring that both endpoints are included even if an uneven time step occurs at the end
`double`	`getTimeStep()`
`int`	`getTimeZone()`
`boolean`	`intersects(TimeExtent timeExtent)` Checks if this timeExtent intersects the given timeExtent
`boolean`	`isBaseAtNow()`
`boolean`	`isBeginNow()`
`boolean`	`isEndNow()`
`boolean`	`isNull()` Check if time is null (i.e.
`boolean`	`isTimeInstant()` Check if this is a single point in time
`void`	`nullify()` Resets all variables so that extent is null (i.e.
`void`	`resizeToContain(double t)` Resizes this extent so that it contains the given time value
`void`	`setBaseAtNow(boolean baseAtNow)`
`void`	`setBaseTime(double baseJulianTime)`
`void`	`setBeginNow(boolean beginNow)`
`void`	`setDeltaTimes(double leadDeltaSeconds, double lagDeltaSeconds)`
`void`	`setEndNow(boolean endNow)`
`void`	`setLagTimeDelta(double seconds)`
`void`	`setLeadTimeDelta(double seconds)`
`void`	`setStartTime(double startTime)` Helper method to set start time
`void`	`setStopTime(double stopTime)` Helper method to set stop time
`void`	`setTimeBias(double seconds)`
`void`	`setTimeStep(double seconds)`
`void`	`setTimeZone(int timeZone)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NOW_ACCURACY
```
public static final double NOW_ACCURACY
```
    See Also:
    Constant Field Values
  - UNKNOWN
```
public static final double UNKNOWN
```
    See Also:
    Constant Field Values
  - NOW
```
public static final double NOW
```
    See Also:
    Constant Field Values
  - baseTime
```
protected double baseTime
```
  - timeBias
```
protected double timeBias
```
  - timeStep
```
protected double timeStep
```
  - leadTimeDelta
```
protected double leadTimeDelta
```
  - lagTimeDelta
```
protected double lagTimeDelta
```
  - baseAtNow
```
protected boolean baseAtNow
```
  - endNow
```
protected boolean endNow
```
  - beginNow
```
protected boolean beginNow
```
  - timeZone
```
protected int timeZone
```
- Constructor Detail
  - TimeExtent
```
public TimeExtent()
```
  - TimeExtent
```
public TimeExtent(double baseJulianTime)
```
  - TimeExtent
```
public TimeExtent(double startTime,
          double stopTime)
```
  - TimeExtent
```
public TimeExtent(double baseJulianTime,
          double timeBiasSeconds,
          double timeStepSeconds,
          double leadTimeDeltaSeconds,
          double lagTimeDeltaSeconds)
```
- Method Detail
  - getNowInstant
```
public static TimeExtent getNowInstant()
```
  - getPeriodStartingNow
```
public static TimeExtent getPeriodStartingNow(double stopTime)
```
  - getPeriodEndingNow
```
public static TimeExtent getPeriodEndingNow(double startTime)
```
  - copy
```
public TimeExtent copy()
```
  - setBaseTime
```
public void setBaseTime(double baseJulianTime)
```
  - setTimeBias
```
public void setTimeBias(double seconds)
```
  - setTimeStep
```
public void setTimeStep(double seconds)
```
  - setLeadTimeDelta
```
public void setLeadTimeDelta(double seconds)
```
  - setLagTimeDelta
```
public void setLagTimeDelta(double seconds)
```
  - setDeltaTimes
```
public void setDeltaTimes(double leadDeltaSeconds,
                 double lagDeltaSeconds)
```
  - getBaseTime
```
public double getBaseTime()
```
    To get baseTime without bias applied. If baseAtNow is set, this retrieves the system's current time
    
    Returns:
    base time as julian time in seconds (1970 based)
  - getAdjustedTime
```
public double getAdjustedTime()
```
    To get baseTime or absTime with bias applied
    
    Returns:
    base time + bias as julian time in seconds (1970 based)
  - getTimeBias
```
public double getTimeBias()
```
  - getTimeStep
```
public double getTimeStep()
```
  - getLeadTimeDelta
```
public double getLeadTimeDelta()
```
  - getLagTimeDelta
```
public double getLagTimeDelta()
```
  - getTimeRange
```
public double getTimeRange()
```
  - getAdjustedLeadTime
```
public double getAdjustedLeadTime()
```
  - getAdjustedLagTime
```
public double getAdjustedLagTime()
```
  - isBaseAtNow
```
public boolean isBaseAtNow()
```
  - setBaseAtNow
```
public void setBaseAtNow(boolean baseAtNow)
```
  - isBeginNow
```
public boolean isBeginNow()
```
  - setBeginNow
```
public void setBeginNow(boolean beginNow)
```
  - isEndNow
```
public boolean isEndNow()
```
  - setEndNow
```
public void setEndNow(boolean endNow)
```
  - getNumberOfSteps
```
public int getNumberOfSteps()
```
    Returns:
    number of full time steps
  - getTimes
```
public double[] getTimes()
```
    Calculates times based on current time settings, always assuring that both endpoints are included even if an uneven time step occurs at the end
    
    Returns:
    time grid spliting the time period evenly
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(TimeExtent timeExtent)
```
    Checks if time extents are equal (no null check) (i.e. stop=stop AND start=start)
    
    Parameters:
    timeExtent -
    
    Returns:
    true if time extents are equal
  - contains
```
public boolean contains(double time)
```
    Checks if this TimeExtent contains the given time
    
    Parameters:
    time -
    
    Returns:
    true if it contains the given time point
  - contains
```
public boolean contains(TimeExtent timeExtent)
```
    Checks if this TimeExtent contains the given TimeExtent
    
    Parameters:
    timeExtent -
    
    Returns:
    true if it contains the given TimeExtent
  - intersects
```
public boolean intersects(TimeExtent timeExtent)
```
    Checks if this timeExtent intersects the given timeExtent
    
    Parameters:
    timeExtent -
    
    Returns:
    true if both TimeExtents intersects
  - isNull
```
public boolean isNull()
```
    Check if time is null (i.e. baseTime is not set)
    
    Returns:
    true if no base time has been set
  - isTimeInstant
```
public boolean isTimeInstant()
```
    Check if this is a single point in time
    
    Returns:
    true if this is a time instant
  - nullify
```
public void nullify()
```
    Resets all variables so that extent is null (i.e. unset)
  - resizeToContain
```
public void resizeToContain(double t)
```
    Resizes this extent so that it contains the given time value
    
    Parameters:
    t - time value (MUST be in same reference frame as the extent)
  - getStartTime
```
public double getStartTime()
```
    Helper method to get start time
    
    Returns:
    start time as julian time in seconds (1970 based)
  - setStartTime
```
public void setStartTime(double startTime)
```
    Helper method to set start time
    
    Parameters:
    startTime - start time as julian time in seconds (1970 based)
  - getStopTime
```
public double getStopTime()
```
    Helper method to get stop time
    
    Returns:
    stop time as julian time in seconds (1970 based)
  - setStopTime
```
public void setStopTime(double stopTime)
```
    Helper method to set stop time
    
    Parameters:
    stopTime - stop time as julian time in seconds (1970 based)
  - getIsoString
```
public String getIsoString(int zone)
```
  - getTimeZone
```
public int getTimeZone()
```
  - setTimeZone
```
public void setTimeZone(int timeZone)
```

Class TimeExtent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOW_ACCURACY

UNKNOWN

NOW

baseTime

timeBias

timeStep

leadTimeDelta

lagTimeDelta

baseAtNow

endNow

beginNow

timeZone

Constructor Detail

TimeExtent

TimeExtent

TimeExtent

TimeExtent

Method Detail

getNowInstant

getPeriodStartingNow

getPeriodEndingNow

copy

setBaseTime

setTimeBias

setTimeStep

setLeadTimeDelta

setLagTimeDelta

setDeltaTimes

getBaseTime

getAdjustedTime

getTimeBias

getTimeStep

getLeadTimeDelta

getLagTimeDelta

getTimeRange

getAdjustedLeadTime

getAdjustedLagTime

isBaseAtNow

setBaseAtNow

isBeginNow

setBeginNow

isEndNow

setEndNow

getNumberOfSteps

getTimes

toString

equals

equals

contains

contains

intersects

isNull

isTimeInstant

nullify

resizeToContain

getStartTime

setStartTime

getStopTime

setStopTime

getIsoString

getTimeZone

setTimeZone