Package gov.nasa.jpl.aerie.merlin.driver

Class CheckpointSimulationDriver

java.lang.Object

gov.nasa.jpl.aerie.merlin.driver.CheckpointSimulationDriver

public class CheckpointSimulationDriver
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CheckpointSimulationDriver.SimulationState

Constructor Summary

Constructors

Constructor	Description
CheckpointSimulationDriver()

Method Summary

Modifier and Type	Method	Description
static Optional<Pair<CachedSimulationEngine,Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>>>	bestCachedEngine(Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> schedule, List<CachedSimulationEngine> cachedEngines, gov.nasa.jpl.aerie.merlin.protocol.types.Duration planDuration)	Selects the best cached engine for simulating a given plan.
static Function<CheckpointSimulationDriver.SimulationState,Boolean>	checkpointAtEnd(Function<CheckpointSimulationDriver.SimulationState,Boolean> stoppingCondition)
static Function<CheckpointSimulationDriver.SimulationState,Boolean>	desiredCheckpoints(List<gov.nasa.jpl.aerie.merlin.protocol.types.Duration> desiredCheckpoints)
static Function<CheckpointSimulationDriver.SimulationState,Boolean>	noCondition()
static Function<CheckpointSimulationDriver.SimulationState,Boolean>	onceAllActivitiesAreFinished()
static <Model> SimulationResultsComputerInputs	simulateWithCheckpoints(MissionModel<Model> missionModel, Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> schedule, Instant simulationStartTime, gov.nasa.jpl.aerie.merlin.protocol.types.Duration simulationDuration, Instant planStartTime, gov.nasa.jpl.aerie.merlin.protocol.types.Duration planDuration, Consumer<gov.nasa.jpl.aerie.merlin.protocol.types.Duration> simulationExtentConsumer, Supplier<Boolean> simulationCanceled, CachedSimulationEngine cachedEngine, Function<CheckpointSimulationDriver.SimulationState,Boolean> shouldTakeCheckpoint, Function<CheckpointSimulationDriver.SimulationState,Boolean> stopConditionOnPlan, CachedEngineStore cachedEngineStore, SimulationEngineConfiguration configuration)	Simulates a plan/schedule while using and creating simulation checkpoints.
static Function<CheckpointSimulationDriver.SimulationState,Boolean>	stopOnceActivityHasFinished(gov.nasa.jpl.aerie.types.ActivityDirectiveId activityDirectiveId)

Methods inherited from class java.lang.Object

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

Constructor Details

CheckpointSimulationDriver

public CheckpointSimulationDriver()

Method Details

bestCachedEngine

public static Optional<Pair<CachedSimulationEngine,Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirectiveId>>> bestCachedEngine(Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> schedule,
 List<CachedSimulationEngine> cachedEngines,
 gov.nasa.jpl.aerie.merlin.protocol.types.Duration planDuration)

Selects the best cached engine for simulating a given plan.

Parameters:

schedule - the schedule/plan

cachedEngines - a list of cached engines

Returns:

the best cached engine as well as the map of corresponding activity ids for this engine

desiredCheckpoints

public static Function<CheckpointSimulationDriver.SimulationState,Boolean> desiredCheckpoints(List<gov.nasa.jpl.aerie.merlin.protocol.types.Duration> desiredCheckpoints)

checkpointAtEnd

public static Function<CheckpointSimulationDriver.SimulationState,Boolean> checkpointAtEnd(Function<CheckpointSimulationDriver.SimulationState,Boolean> stoppingCondition)

simulateWithCheckpoints

public static <Model>
SimulationResultsComputerInputs simulateWithCheckpoints(MissionModel<Model> missionModel,
 Map<gov.nasa.jpl.aerie.types.ActivityDirectiveId,gov.nasa.jpl.aerie.types.ActivityDirective> schedule,
 Instant simulationStartTime,
 gov.nasa.jpl.aerie.merlin.protocol.types.Duration simulationDuration,
 Instant planStartTime,
 gov.nasa.jpl.aerie.merlin.protocol.types.Duration planDuration,
 Consumer<gov.nasa.jpl.aerie.merlin.protocol.types.Duration> simulationExtentConsumer,
 Supplier<Boolean> simulationCanceled,
 CachedSimulationEngine cachedEngine,
 Function<CheckpointSimulationDriver.SimulationState,Boolean> shouldTakeCheckpoint,
 Function<CheckpointSimulationDriver.SimulationState,Boolean> stopConditionOnPlan,
 CachedEngineStore cachedEngineStore,
 SimulationEngineConfiguration configuration)

Simulates a plan/schedule while using and creating simulation checkpoints.

Parameters:

missionModel - the mission model

schedule - the plan/schedule

simulationStartTime - the start time of the simulation

simulationDuration - the simulation duration

planStartTime - the plan overall start time

planDuration - the plan overall duration

simulationExtentConsumer - consumer to report simulation progress

simulationCanceled - provider of an external stop signal

cachedEngine - the simulation engine that is going to be used

shouldTakeCheckpoint - a function from state of the simulation to boolean deciding when to take checkpoints

stopConditionOnPlan - a function from state of the simulation to boolean deciding when to stop simulation

cachedEngineStore - a store for simulation engine checkpoints taken. If capacity is 1, the simulation will behave like a resumable simulation.

configuration - the simulation configuration

Returns:

all the information to compute simulation results if needed

onceAllActivitiesAreFinished

public static Function<CheckpointSimulationDriver.SimulationState,Boolean> onceAllActivitiesAreFinished()

noCondition

public static Function<CheckpointSimulationDriver.SimulationState,Boolean> noCondition()

stopOnceActivityHasFinished

public static Function<CheckpointSimulationDriver.SimulationState,Boolean> stopOnceActivityHasFinished(gov.nasa.jpl.aerie.types.ActivityDirectiveId activityDirectiveId)