mapsglmaps/com.xweather.mapsgl.data.series/TimeSeries

TimeSeries

class TimeSeries<Data>(data: HashMap<TimeIntervalKey, Data>? = null)

A class that represents a time series of data.

Constructors

constructor(data: HashMap<TimeIntervalKey, Data>? = null)

Properties

The number of entries in the time series.

val data: SeriesData<Data>

The data associated with the time series.

val intervals: MutableList<TimeInterval>

The time intervals for the time series.

val timeRange: TimeRange

The time range covered by the time series.

val validCount: Int

The number of entries in the time series that contain valid data.

Functions

fun appendData(data: SeriesData<Data>)

closestInterval

fun closestInterval(date: Date): Pair<TimeInterval?, Int>

Returns the interval closest to the provided date within the time series.

fun dataAtIndex(index: Int): Data?

Returns the data associated with the specified index in the time series.

dataForInterval

fun dataForInterval(interval: TimeInterval): Data?

Returns the data associated with the specified interval in the time series.

dataForTimeInterval

fun dataForTimeInterval(interval: TimeInterval): Data?

Returns the data associated with the specified time interval in the time series.

entryForInterval

fun entryForInterval(interval: TimeInterval): TimeSeriesEntry<Data>?

Returns the time series entry for the specified interval if exists.

hasDataForInterval

fun hasDataForInterval(interval: TimeInterval, checkValid: Boolean = false): Boolean

Returns whether the time series contains data for the specified time interval.

intervalAtIndex

fun intervalAtIndex(index: Int): TimeInterval?

Returns the time interval at the specified index in the time series.

intervalsInRange

fun intervalsInRange(start: Date, end: Date, includeStops: Boolean = true): MutableList<TimeInterval>

Returns the time intervals within the specified range for the time series. If includeStops is true, then the start and end values will be allowed in the returned set of time intervals. Default is true.

intervalsNeedingData

fun intervalsNeedingData(intervals: List<TimeInterval> = this.intervals): List<TimeInterval>

Returns an array of time intervals that do not have data associated with them based on the passed array of intervals. If no intervals are provided, then the current intervals for the time series are used.

fun invalidate()

Clears the data associated with the time series.

fun removeInterval(interval: TimeInterval)

Removes the time interval and associated data from the time series.

fun setData(data: HashMap<TimeIntervalKey, Data>?)

Sets the data for the time series.

fun setDataAny(data: HashMap<String, Any>?)

setDataForInterval

fun setDataForInterval(interval: TimeInterval, data: Data?, createIfMissing: Boolean = false)

Sets the data for the specified time interval in the time series.