Scheduling/gov.nasa.ammos.aerie.procedural.scheduling.plan/EditablePlan

EditablePlan

interface EditablePlan : Plan

A plan representation that can be edited and simulated.

Inheritors

DefaultEditablePlanDriver

Functions

commit

abstract fun commit()

Commit plan edits, making them final.

create

abstract fun create(directive: NewDirective): ActivityDirectiveId

Create a new activity.

open fun create(type: String, start: DirectiveStart, arguments: Map<String, SerializedValue>): ActivityDirectiveId

A simplified version of create with minimal arguments.

delete

open fun delete(directive: Directive<AnyDirective>)

Delete an activity and throw an error if any activities are anchored to it.

open fun delete(id: ActivityDirectiveId)

Delete an activity specified by directive id, and throw an error if any activities are anchored to it.

abstract fun delete(directive: Directive<AnyDirective>, strategy: DeletedAnchorStrategy)

Delete an activity with a strategy to handle activities that are anchored to it.

abstract fun delete(id: ActivityDirectiveId, strategy: DeletedAnchorStrategy)

Delete an activity specified by directive id, with a strategy to handle activities that are anchored to it.

directives

open fun directives(): Directives<AnyDirective>

Queries all activity directives, deserializing them as AnyDirective.

open fun directives(type: String): Directives<AnyDirective>

Queries activity directives, filtered by type, deserializing them as AnyDirective.

abstract fun <A : Any> directives(type: String?, deserializer: (SerializedValue) -> A): Directives<A>

Query activity directives.

duration

open fun duration(): Duration

The total duration of the plan, whether simulated on the full extent or not.

events

open fun events(): ExternalEvents

Get all external events across all derivation groups associated with this plan.

abstract fun events(query: EventQuery): ExternalEvents

Get external events associated with this plan.

latestResults

abstract fun latestResults(): SimulationResults?

Get the latest simulation results.

resource

abstract fun <V : Any, TL : SerialSegmentOps<V, TL>> resource(name: String, deserializer: (List<Segment<SerializedValue>>) -> TL): TL

Query a resource profile from the external datasets associated with this plan.

rollback

abstract fun rollback(): List<Edit>

Roll back uncommitted edits.

simulate

open fun simulate(): SimulationResults

A simplified version of simulate which uses the default configuration.

abstract fun simulate(options: SimulateOptions): SimulationResults

Simulate the current plan, including committed and uncommitted changes.

toAbsolute

abstract fun toAbsolute(rel: Duration): Instant

Convert a relative duration to a time instant.

toRelative

abstract fun toRelative(abs: Instant): Duration

Convert a time instant to a relative duration (relative to plan start).

totalBounds

abstract fun totalBounds(): Interval

Total extent of the plan's bounds, whether it was simulated on the full extent or not.