Timeline/gov.nasa.ammos.aerie.procedural.timeline/Interval

Interval

data class Interval @JvmOverloads constructor(val start: Duration, val end: Duration, val startInclusivity: Interval.Inclusivity = Inclusivity.Inclusive, val endInclusivity: Interval.Inclusivity = startInclusivity) : IntervalLike<Interval>

An Interval on the timeline, represented by start and end points and start and end inclusivity.

Constructors

constructor(start: Duration, end: Duration, startInclusivity: Interval.Inclusivity = Inclusivity.Inclusive, endInclusivity: Interval.Inclusivity = startInclusivity)

Types

object Companion

Helper functions for constructing Intervals.

enum Inclusivity : Enum<Interval.Inclusivity>

Labels to indicate whether an interval includes its endpoints.

Properties

val end: Duration

val endInclusivity: Interval.Inclusivity

Whether this interval contains its end time.

val start: Duration

startInclusivity

val startInclusivity: Interval.Inclusivity

Whether this interval contains its start time.

Functions

infix fun adjacentTo(x: Interval): Boolean

Whether this interval meets or is metBy another.

fun compareEnds(other: Interval): Int

Compare the end times of this and another interval.

compareEndToStart

fun compareEndToStart(other: Interval): Int

Compares the end of this interval to the start of another interval.

fun compareStarts(other: Interval): Int

Compare the start times of this and another interval.

compareStartToEnd

fun compareStartToEnd(other: Interval): Int

Opposite of compareEndToStart.

operator fun contains(x: Interval): Boolean

Whether this interval contains the entirety of another.

operator fun contains(d: Duration): Boolean

Whether a given time is contained in this interval.

fun duration(): Duration

Length of the interval, represented as a Duration object.

infix fun hasSameEndAs(other: Interval): Boolean

Whether this and another interval end at the same time, accounting for inclusivity.

infix fun hasSameStartAs(other: Interval): Boolean

Whether this and another interval start at the same time, accounting for inclusivity.

infix fun hull(other: Interval): Interval

The smallest interval that contains both this and another interval.

fun includesEnd(): Boolean

Whether this interval includes its end point.

fun includesStart(): Boolean

Whether this interval includes its start point.

infix fun intersection(other: Interval): Interval

Calculates the intersection between this interval and another.

fun isEmpty(): Boolean

Whether this interval contains any points.

fun isPoint(): Boolean

Whether this interval contains only a single point.

isStrictlyAfter

infix fun isStrictlyAfter(x: Interval): Boolean

Whether this interval happens after another interval with no overlap.

isStrictlyBefore

infix fun isStrictlyBefore(x: Interval): Boolean

Whether this interval happens before another interval with no overlap.

infix fun meets(other: Interval): Boolean

Whether this interval precedes another and touches it without overlap.

infix fun metBy(other: Interval): Boolean

Whether this interval comes after another and touches it without overlap.

operator fun minus(other: Interval): List<Interval>

Removes all points in the argument interval from this interval. This is essentially the opposite of union.

fun shiftBy(shiftStart: Duration, shiftEnd: Duration = shiftStart): Interval

Shifts the start and end points equally forward or backward in time.

infix fun step(stride: Duration): Iterable<Duration>

Creates an iterable that produces durations spread out over the interval, separated by stride.

open override fun toString(): String

infix fun union(other: Interval): List<Interval>

Calculates the union between this interval and another, as a list of intervals.