Package gov.nasa.jpl.aerie.scheduler.goals

Class RecurrenceGoal

java.lang.Object

gov.nasa.jpl.aerie.scheduler.goals.Goal

gov.nasa.jpl.aerie.scheduler.goals.ActivityExistentialGoal

gov.nasa.jpl.aerie.scheduler.goals.ActivityTemplateGoal

gov.nasa.jpl.aerie.scheduler.goals.RecurrenceGoal

public class RecurrenceGoal
extends ActivityTemplateGoal

describes the desired recurrence of an activity every time period

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecurrenceGoal.Builder	the builder can construct goals piecemeal via a series of method calls

Field Summary

Fields

Modifier and Type	Field	Description
protected gov.nasa.jpl.aerie.merlin.protocol.types.Duration	lastActivityStartedAt	the start time of the last (fictional) activity before the horizon start Can be negative.
protected gov.nasa.jpl.aerie.constraints.time.Interval	recurrenceInterval	the allowable range of durations over which a target activity must repeat Of type: MinMaxAllowableRecurrenceInterval REVIEW: need to work out semantics of min on recurrenceInterval

Fields inherited from class gov.nasa.jpl.aerie.scheduler.goals.ActivityTemplateGoal

desiredActTemplate, matchActTemplate

Fields inherited from class gov.nasa.jpl.aerie.scheduler.goals.ActivityExistentialGoal

childCustody

Fields inherited from class gov.nasa.jpl.aerie.scheduler.goals.Goal

name, planHorizon, resourceConstraints, simulateAfter, temporalContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RecurrenceGoal()	ctor creates an empty goal without details client code should use builders to instance goals

Method Summary

Modifier and Type	Method	Description
Collection<Conflict>	getConflicts(Plan plan, gov.nasa.jpl.aerie.constraints.model.SimulationResults simulationResults, gov.nasa.jpl.aerie.constraints.model.EvaluationEnvironment evaluationEnvironment, gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)	identifies issues in a plan that diminishes this goal's satisfaction the method must return the same issues in the same order given the same input plan, but they need not be otherwise sorted an empty return list indicates that no issues could be identified in the plan that this goal would care to improve upon

Methods inherited from class gov.nasa.jpl.aerie.scheduler.goals.ActivityTemplateGoal

extractResources, getActivityStateConstraints, getActTemplate

Methods inherited from class gov.nasa.jpl.aerie.scheduler.goals.ActivityExistentialGoal

getChildCustody

Methods inherited from class gov.nasa.jpl.aerie.scheduler.goals.Goal

getName, getResourceConstraints, getTemporalContext, setTemporalContext, shouldRollbackIfUnsatisfied

Methods inherited from class java.lang.Object

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

Field Details

recurrenceInterval

protected gov.nasa.jpl.aerie.constraints.time.Interval recurrenceInterval

the allowable range of durations over which a target activity must repeat Of type: MinMaxAllowableRecurrenceInterval REVIEW: need to work out semantics of min on recurrenceInterval

lastActivityStartedAt

protected gov.nasa.jpl.aerie.merlin.protocol.types.Duration lastActivityStartedAt

the start time of the last (fictional) activity before the horizon start Can be negative. By default, set to -recurrenceInterval.max

Constructor Details

RecurrenceGoal

protected RecurrenceGoal()

ctor creates an empty goal without details client code should use builders to instance goals

Method Details

getConflicts

public Collection<Conflict> getConflicts(@NotNull
 Plan plan,
 gov.nasa.jpl.aerie.constraints.model.SimulationResults simulationResults,
 gov.nasa.jpl.aerie.constraints.model.EvaluationEnvironment evaluationEnvironment,
 gov.nasa.jpl.aerie.merlin.protocol.model.SchedulerModel schedulerModel)

identifies issues in a plan that diminishes this goal's satisfaction the method must return the same issues in the same order given the same input plan, but they need not be otherwise sorted an empty return list indicates that no issues could be identified in the plan that this goal would care to improve upon collects conflicts wherein a matching target activity instance does not exist over a timespan longer than the allowed range (and one should probably be created!)

Overrides:

getConflicts in class Goal

Parameters:

plan - IN: the plan that this goal should be evaluated against

simulationResults -

Returns:

a list of issues in the plan that diminish goal satisfaction