Timeline/gov.nasa.ammos.aerie.procedural.timeline.collections/ExternalEvents

ExternalEvents

data class ExternalEvents(timeline: Timeline<ExternalEvent, ExternalEvents>) : Timeline<ExternalEvent, ExternalEvents> , NonZeroDurationOps<ExternalEvent, ExternalEvents> , ParallelOps<ExternalEvent, ExternalEvents>

A timeline of external events.

Constructors

ExternalEvents

constructor(vararg events: ExternalEvent)

constructor(events: List<ExternalEvent>)

constructor(timeline: Timeline<ExternalEvent, ExternalEvents>)

Functions

accumulatedDuration

open fun accumulatedDuration(unit: Duration): Real

(DOC) Creates a Real profile corresponding to the running total of time that this timeline has had an active object.

active

open fun active(): Booleans

(DOC) Returns a Booleans profile that is true when this timeline has an active object.

cache

open override fun cache(): ExternalEvents

(DOC) Caches the timeline for all available time.

open override fun cache(opts: CollectOptions): ExternalEvents

Caches the result of collecting this timeline, to be reused for future collect requests if possible.

open override fun cache(bounds: Interval): ExternalEvents

(DOC) A simplified version of cache.

collect

open override fun collect(): List<ExternalEvent>

(DOC) Collects the timeline for all available time.

open override fun collect(opts: CollectOptions): List<ExternalEvent>

(DOC) Evaluates the stack of operations and produces a list of timeline payload objects.

open override fun collect(bounds: Interval): List<ExternalEvent>

(DOC) A simplified version of collect.

connectTo

open fun <U : IntervalLike<U>> connectTo(other: ParallelOps<U, *>, connectToBounds: Boolean): Universal<Connection<ExternalEvent, U>>

(DOC) Creates an Universal object of Connections that associate of this timeline's object to the (chronologically) next object in another timeline that starts after this one ends.

convert

open fun <RESULT : GeneralOps<ExternalEvent, RESULT>> convert(ctor: (Timeline<ExternalEvent, RESULT>) -> RESULT): RESULT

(DOC) Safely converts to another timeline type that accepts the same payload type.

countActive

open fun countActive(): Numbers<Int>

(DOC) Returns a Numbers profile that corresponds to the number of active objects at any given time.

ends

open fun ends(): ExternalEvents

(DOC) Truncates each object to only its end time.

filter

open fun filter(preserveMargin: Boolean = false, f: (ExternalEvent) -> Boolean): ExternalEvents

(DOC) Removes or retains objects based on a predicate.

filterByDerivationGroup

fun filterByDerivationGroup(vararg groups: String): ExternalEvents

Filter by one or more derivation groups.

filterByDuration

open fun filterByDuration(validInterval: Interval): ExternalEvents

(DOC) Removes objects whose duration is outside a given valid interval.

filterBySource

fun filterBySource(vararg sources: ExternalSource): ExternalEvents

Filter by one or more event sources.

filterByType

fun filterByType(vararg types: String): ExternalEvents

Filter by one or more types.

filterByWindows

open fun filterByWindows(windows: SerialOps<Interval, *>, truncateMarginal: Boolean = true): ExternalEvents

(DOC) Filters out payload objects whose intervals are not contained in the given Windows timeline.

filterLongerThan

open fun filterLongerThan(dur: Duration): ExternalEvents

(DOC) Removes objects whose duration is shorter than a given duration.

filterShorterThan

open fun filterShorterThan(dur: Duration): ExternalEvents

(DOC) Removes objects whose duration is longer than a given duration.

flattenIntoProfile

open fun <R : Any, RESULT : SerialSegmentOps<R, RESULT>> flattenIntoProfile(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, f: (ExternalEvent) -> R): RESULT

(DOC) Converts the payload objects into segments and flattens them into a serial profile.

forEach

open fun forEach(p0: Consumer<in ExternalEvent>)

highlight

open fun highlight(f: (ExternalEvent) -> Boolean): Windows

(DOC) Similar to filter, but produces a coalesced Windows object that highlights everything that satisfies the predicate.

highlightAll

open fun highlightAll(): Windows

(DOC) Highlights all objects in the timeline in a new Windows timeline.

inspect

open fun inspect(f: Consumer<List<ExternalEvent>>): ExternalEvents

(DOC) Inserts a no-op function into the operation stack to allow side effects, such as printing.

isolate

open fun isolate(f: (ExternalEvent) -> Boolean): Universal<ExternalEvent>

(DOC) Similar to filter, but returns an Universal timeline.

iterator

open operator override fun iterator(): Iterator<ExternalEvent>

merge

open infix fun merge(other: GeneralOps<ExternalEvent, *>): ExternalEvents

(DOC) Combines two timelines together by overlaying them. Does not perform any transformation.

open infix fun merge(i: ExternalEvent): ExternalEvents

(DOC) Combines this timeline with a single payload object by overlaying them.

reduceIntoProfile

open fun <R : Any, RESULT : SerialSegmentOps<R, RESULT>> reduceIntoProfile(ctor: (Timeline<Segment<R>, RESULT>) -> RESULT, op: NullBinaryOperation<ExternalEvent, R, R>): RESULT

(DOC) Converts the payload objects into segments and combines them into a serial profile.

rollingDuration

open fun rollingDuration(range: Duration, unit: Duration): Real

(DOC) Calculates the sum of durations of objects in a range leading the current time.

select

open fun select(interval: Interval): ExternalEvents

(DOC) Restricts the timeline to only be evaluated in the given interval.

shift

open fun shift(dur: Duration): ExternalEvents

(DOC) Uniformly shifts the entire timeline in time (positive shifts toward the future).

shiftEndpoints

open fun shiftEndpoints(shiftStart: Duration, shiftEnd: Duration = shiftStart): ExternalEvents

(DOC) Shifts the start and end points of each object.

split

open fun split(f: (ExternalEvent) -> Int): ExternalEvents

(DOC) Splits payload objects into a variable number of equally sized pieces.

spliterator

open fun spliterator(): Spliterator<ExternalEvent>

starts

open fun starts(): ExternalEvents

(DOC) Truncates each object to only its start time.

unsafeCast

open override fun <RESULT : Timeline<ExternalEvent, RESULT>> unsafeCast(ctor: (Timeline<ExternalEvent, RESULT>) -> RESULT): RESULT

(DOC) UNSAFE! Casts this timeline type to another type without changing its contents.

unsafeFlatMap

open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeFlatMap(ctor: (Timeline<R, RESULT>) -> RESULT, boundsTransformer: BoundsTransformer, truncate: Boolean, f: (ExternalEvent) -> Segment<GeneralOps<R, *>>): RESULT

(DOC) UNSAFE! Maps each object to a nested timeline and flattens all the timelines into one.

unsafeMap

open fun unsafeMap(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (ExternalEvent) -> ExternalEvent): ExternalEvents

(DOC) UNSAFE! A simpler version of unsafeMap for operations that don't change the timeline type.

open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeMap(ctor: (Timeline<R, RESULT>) -> RESULT, boundsTransformer: BoundsTransformer, truncate: Boolean, f: (ExternalEvent) -> R): RESULT

(DOC) UNSAFE! Maps each timeline object to another object, of potentially a different type, at potentially a different time.

unsafeMap2

open fun <W : IntervalLike<W>, R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeMap2(ctor: (Timeline<R, RESULT>) -> RESULT, other: GeneralOps<W, *>, op: (ExternalEvent, W, Interval) -> R?): RESULT

Performs a generalized binary operation between this and another timeline.

unsafeMapIntervals

open fun unsafeMapIntervals(boundsTransformer: BoundsTransformer, truncate: Boolean, f: (ExternalEvent) -> Interval): ExternalEvents

(DOC) UNSAFE! Maps the interval of each object, leaving the rest of the object unchanged.

unsafeOperate

open fun unsafeOperate(f: Timeline<ExternalEvent, ExternalEvents>.(opts: CollectOptions) -> List<ExternalEvent>): ExternalEvents

(DOC) UNSAFE! A simpler version of unsafeOperate for operations that don't change the timeline type.

open fun <R : IntervalLike<R>, RESULT : GeneralOps<R, RESULT>> unsafeOperate(ctor: (Timeline<R, RESULT>) -> RESULT, f: Timeline<ExternalEvent, ExternalEvents>.(opts: CollectOptions) -> List<R>): RESULT

(DOC) UNSAFE! The basic, most general operation method. All operations eventually delegate here.

unset

open fun unset(reject: Interval): ExternalEvents

(DOC) Unsets everything in a given interval. Timeline objects whose intervals fully contain the rejected interval may be split into two objects.