uk.ac.starlink.ttools.mode

Class TimeIntervalType

java.lang.Object

uk.ac.starlink.ttools.mode.TimeIntervalType

public abstract class TimeIntervalType
extends Object

Defines how a range in epoch can be defined by one or two supplied quantities.

Since:

10 Feb 2026

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static TimeIntervalType	DAY_EXTENT Interval starting at given epoch, extent given in days by secondary coordinate.
static TimeIntervalType	DAY_RADIUS Interval centered on given epoch, half-extent given in days by secondary coordinate.
static TimeIntervalType	POINT Single epoch interval, zero extent.
static TimeIntervalType	RANGE Interval between two given epochs.
static TimeIntervalType	SEC_EXTENT Interval starting at given epoch, extent given in seconds by secondary coordinate.
static TimeIntervalType	SEC_RADIUS Interval centered on given epoch, half-extent given in seconds by secondary coordinate.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeIntervalType(String name, boolean hasT1) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract String	getDescription(String t0name, String t1name) Returns a description of this interval type, based on the UI parameter names of the primary and secondary time coordinates.
String	getName() Returns the name of this interval type.
static TimeIntervalType[]	getTypes() Returns a list of useful instances of this class.
boolean	hasT1() Indicates whether this interval type makes use of the secondary time coordinate.
abstract double[]	toJdInterval(double jd0, Object t1data, TimeMapper mapper) Converts the supplied values into an interval in Julian Date.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

POINT

public static final TimeIntervalType POINT

Single epoch interval, zero extent.

RANGE

public static final TimeIntervalType RANGE

Interval between two given epochs.

DAY_EXTENT

public static final TimeIntervalType DAY_EXTENT

Interval starting at given epoch, extent given in days by secondary coordinate.

DAY_RADIUS

public static final TimeIntervalType DAY_RADIUS

Interval centered on given epoch, half-extent given in days by secondary coordinate.

SEC_EXTENT

public static final TimeIntervalType SEC_EXTENT

Interval starting at given epoch, extent given in seconds by secondary coordinate.

SEC_RADIUS

public static final TimeIntervalType SEC_RADIUS

Interval centered on given epoch, half-extent given in seconds by secondary coordinate.

Constructor Detail

TimeIntervalType

protected TimeIntervalType(String name,
                           boolean hasT1)

Constructor.

Parameters:

name - interval type name

hasT1 - true iff this interval type uses the secondary time coordinate

Method Detail

getName

public String getName()

Returns the name of this interval type.

Returns:

name

hasT1

public boolean hasT1()

Indicates whether this interval type makes use of the secondary time coordinate.

Returns:

true for 2-coordinate intervals

getDescription

public abstract String getDescription(String t0name,
                                      String t1name)

Returns a description of this interval type, based on the UI parameter names of the primary and secondary time coordinates.

Parameters:

t0name - name of the primary time coordinate parameter

t1name - name of the secondary time coordinate parameter

Returns:

XML-friendly user-readable description

toJdInterval

public abstract double[] toJdInterval(double jd0,
                                      Object t1data,
                                      TimeMapper mapper)

Converts the supplied values into an interval in Julian Date.

Parameters:

jd0 - primary time coordinate, giving the primary epoch, not NaN

t1data - secondary time coordinate, semantics dependent on this implementation

mapper - mapper from user-supplied coordinate values to epoch

Returns:

2-element array giving (start, end) epoch in JD, or null if input invalid

toString

public String toString()

Overrides:

toString in class Object

getTypes

public static TimeIntervalType[] getTypes()

Returns a list of useful instances of this class.

Returns:

TimeIntervalType instances