org.cesiumjs.cs.core

Class TimeInterval

java.lang.Object

org.cesiumjs.cs.core.TimeInterval

@JsType(isNative=true,
        namespace="Cesium",
        name="TimeInterval")
public class TimeInterval
extends Object

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimeInterval.DataComparer Function interface for comparing interval data.
static interface	TimeInterval.MergeCallback Function interface for merging interval data.

Field Summary

Fields

Modifier and Type	Field and Description
Object	data Gets or sets the data associated with this interval.
boolean	isStartIncluded Gets or sets whether or not the start time is included in this interval.
boolean	isStopIncluded Gets or sets whether or not the stop time is included in this interval.
JulianDate	start Gets or sets the start time of this interval.
JulianDate	stop Gets or sets the stop time of this interval.

Constructor Summary

Constructors

Constructor and Description
TimeInterval() An interval defined by a start and a stop time; optionally including those times as part of the interval.
TimeInterval(TimeIntervalOptions options) An interval defined by a start and a stop time; optionally including those times as part of the interval.

Method Summary

Modifier and Type	Method and Description
TimeInterval	clone() Duplicates this instance.
static TimeInterval	clone(TimeInterval timeInterval, TimeInterval result) Duplicates the provided instance.
static boolean	contains(TimeInterval timeInterval, JulianDate julianDate) Checks if the specified date is inside the provided interval.
static TimeInterval	create(JulianDate start, JulianDate stop)
TimeInterval	EMPTY() An immutable empty interval.
boolean	equals(TimeInterval right) Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.
boolean	equals(TimeInterval right, TimeInterval.DataComparer dataComparer) Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.
static boolean	equals(TimeInterval left, TimeInterval right) Compares two instances and returns true if they are equal, false otherwise.
static boolean	equals(TimeInterval left, TimeInterval right, TimeInterval.DataComparer dataComparer) Compares two instances and returns true if they are equal, false otherwise.
boolean	equalsEpsilon(TimeInterval right, double epsilon) Compares this instance against the provided instance componentwise and returns true if they are within the provided epsilon, false otherwise.
boolean	equalsEpsilon(TimeInterval right, double epsilon, TimeInterval.DataComparer dataComparer) Compares this instance against the provided instance componentwise and returns true if they are within the provided epsilon, false otherwise.
static boolean	equalsEpsilon(TimeInterval left, TimeInterval right, double epsilon) Compares two instances and returns true if they are within epsilon seconds of each other.
static boolean	equalsEpsilon(TimeInterval left, TimeInterval right, double epsilon, TimeInterval.DataComparer dataComparer) Compares two instances and returns true if they are within epsilon seconds of each other.
static TimeInterval	fromIso8601(TimeIntervalIso8601Options options) Creates a new instance from an ISO 8601 interval.
static TimeInterval	fromIso8601(TimeIntervalIso8601Options options, TimeInterval result) Creates a new instance from an ISO 8601 interval.
static TimeInterval	intersect(TimeInterval left, TimeInterval right, TimeInterval result)
static TimeInterval	intersect(TimeInterval left, TimeInterval right, TimeInterval result, TimeInterval.MergeCallback mergeCallback)
boolean	isEmpty() Gets whether or not this interval is empty.
static String	toIso8601(TimeInterval timeInterval) Creates an ISO8601 representation of the provided interval.
static String	toIso8601(TimeInterval timeInterval, double precision) Creates an ISO8601 representation of the provided interval.
String	toString() Creates a string representing this TimeInterval in ISO8601 format.

Methods inherited from class java.lang.Object

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

Field Detail

data

@JsProperty
public Object data

Gets or sets the data associated with this interval.

isStartIncluded

@JsProperty
public boolean isStartIncluded

Gets or sets whether or not the start time is included in this interval. Default: true

isStopIncluded

@JsProperty
public boolean isStopIncluded

Gets or sets whether or not the stop time is included in this interval. Default: true

start

@JsProperty
public JulianDate start

Gets or sets the start time of this interval.

stop

@JsProperty
public JulianDate stop

Gets or sets the stop time of this interval.

Constructor Detail

TimeInterval

@JsConstructor
public TimeInterval()

An interval defined by a start and a stop time; optionally including those times as part of the interval. Arbitrary data can optionally be associated with each instance for used with TimeIntervalCollection.

TimeInterval

@JsConstructor
public TimeInterval(TimeIntervalOptions options)

An interval defined by a start and a stop time; optionally including those times as part of the interval. Arbitrary data can optionally be associated with each instance for used with TimeIntervalCollection.

Parameters:

options - Options

Method Detail

EMPTY

@JsProperty(name="EMPTY")
public TimeInterval EMPTY()

An immutable empty interval.

isEmpty

@JsProperty(name="isEmpty")
public boolean isEmpty()

Gets whether or not this interval is empty.

create

@JsOverlay
public static TimeInterval create(JulianDate start,
                                             JulianDate stop)

clone

@JsMethod
public static TimeInterval clone(TimeInterval timeInterval,
                                           TimeInterval result)

Duplicates the provided instance.

Parameters:

timeInterval - The instance to clone.

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

contains

@JsMethod
public static boolean contains(TimeInterval timeInterval,
                                         JulianDate julianDate)

Checks if the specified date is inside the provided interval.

Parameters:

timeInterval - The interval.

julianDate - The date to check.

Returns:

true if the interval contains the specified date, false otherwise.

equals

@JsMethod
public static boolean equals(TimeInterval left,
                                       TimeInterval right)

Compares two instances and returns true if they are equal, false otherwise.

Parameters:

left - The first instance.

right - The second instance.

Returns:

true if the dates are equal; otherwise, false.

equals

@JsMethod
public static boolean equals(TimeInterval left,
                                       TimeInterval right,
                                       TimeInterval.DataComparer dataComparer)

Compares two instances and returns true if they are equal, false otherwise.

Parameters:

left - The first instance.

right - The second instance.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

true if the dates are equal; otherwise, false.

equalsEpsilon

@JsMethod
public static boolean equalsEpsilon(TimeInterval left,
                                              TimeInterval right,
                                              double epsilon)

Compares two instances and returns true if they are within epsilon seconds of each other. That is, in order for the dates to be considered equal (and for this function to return true), the absolute value of the difference between them, in seconds, must be less than epsilon.

Parameters:

left - The first instance.

right - The second instance.

epsilon - The maximum number of seconds that should separate the two instances.

Returns:

true if the two dates are within epsilon seconds of each other; otherwise false.

equalsEpsilon

@JsMethod
public static boolean equalsEpsilon(TimeInterval left,
                                              TimeInterval right,
                                              double epsilon,
                                              TimeInterval.DataComparer dataComparer)

Compares two instances and returns true if they are within epsilon seconds of each other. That is, in order for the dates to be considered equal (and for this function to return true), the absolute value of the difference between them, in seconds, must be less than epsilon.

Parameters:

left - The first instance.

right - The second instance.

epsilon - The maximum number of seconds that should separate the two instances.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

true if the two dates are within epsilon seconds of each other; otherwise false.

fromIso8601

@JsMethod
public static TimeInterval fromIso8601(TimeIntervalIso8601Options options)

Creates a new instance from an ISO 8601 interval.

Parameters:

options - Options.

Returns:

The modified result parameter or a new instance if none was provided.

fromIso8601

@JsMethod
public static TimeInterval fromIso8601(TimeIntervalIso8601Options options,
                                                 TimeInterval result)

Creates a new instance from an ISO 8601 interval.

Parameters:

options - Options.

result - An existing instance to use for the result.

Returns:

The modified result parameter or a new instance if none was provided.

intersect

@JsMethod
public static TimeInterval intersect(TimeInterval left,
                                               TimeInterval right,
                                               TimeInterval result)

Parameters:

left - The first interval.

right - The second interval.

result - An existing instance to use for the result.

Returns:

The modified result parameter.

intersect

@JsMethod
public static TimeInterval intersect(TimeInterval left,
                                               TimeInterval right,
                                               TimeInterval result,
                                               TimeInterval.MergeCallback mergeCallback)

Parameters:

left - The first interval.

right - The second interval.

result - An existing instance to use for the result.

mergeCallback - A function which merges the data of the two intervals. If omitted, the data from the left interval will be used.

Returns:

The modified result parameter.

toIso8601

@JsMethod
public static String toIso8601(TimeInterval timeInterval)

Creates an ISO8601 representation of the provided interval.

Parameters:

timeInterval - The interval to be converted.

Returns:

The ISO8601 representation of the provided interval.

toIso8601

@JsMethod
public static String toIso8601(TimeInterval timeInterval,
                                         double precision)

Creates an ISO8601 representation of the provided interval.

Parameters:

timeInterval - The interval to be converted.

precision - The number of fractional digits used to represent the seconds component. By default, the most precise representation is used.

Returns:

The ISO8601 representation of the provided interval.

clone

@JsMethod
public TimeInterval clone()

Duplicates this instance.

Overrides:

clone in class Object

Returns:

a new instance if none was provided.

equals

@JsMethod
public boolean equals(TimeInterval right)

Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side interval.

Returns:

true if they are equal, false otherwise.

equals

@JsMethod
public boolean equals(TimeInterval right,
                                TimeInterval.DataComparer dataComparer)

Compares this instance against the provided instance componentwise and returns true if they are equal, false otherwise.

Parameters:

right - The right hand side interval.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

true if they are equal, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(TimeInterval right,
                                       double epsilon)

Compares this instance against the provided instance componentwise and returns true if they are within the provided epsilon, false otherwise.

Parameters:

right - The right hand side interval.

epsilon - The epsilon to use for equality testing.

Returns:

true if they are within the provided epsilon, false otherwise.

equalsEpsilon

@JsMethod
public boolean equalsEpsilon(TimeInterval right,
                                       double epsilon,
                                       TimeInterval.DataComparer dataComparer)

Compares this instance against the provided instance componentwise and returns true if they are within the provided epsilon, false otherwise.

Parameters:

right - The right hand side interval.

epsilon - The epsilon to use for equality testing.

dataComparer - A function which compares the data of the two intervals. If omitted, reference equality is used.

Returns:

true if they are within the provided epsilon, false otherwise.

toString

@JsMethod
public String toString()

Creates a string representing this TimeInterval in ISO8601 format.

Overrides:

toString in class Object

Returns:

A string representing this TimeInterval in ISO8601 format.