Package gov.nasa.jpl.aerie.scheduler.solver

Class Evaluation.GoalEvaluation

java.lang.Object

gov.nasa.jpl.aerie.scheduler.solver.Evaluation.GoalEvaluation

Enclosing class:

Evaluation

public static class Evaluation.GoalEvaluation
extends Object

description of the satisfaction of a single goal in isolation

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<SchedulingActivity,Boolean>	acts	a map associating each activity that contributed to the goal to a boolean stating whether the goal created it or not
protected final Map<Conflict,ConflictSolverResult>	conflicts

Constructor Summary

Constructors

Constructor	Description
GoalEvaluation()

Method Summary

Modifier and Type	Method	Description
void	addConflicts(Collection<Conflict> conflict)
void	associate(SchedulingActivity act, boolean createdByThisGoal, Conflict conflict)	flags given activity as contributing to the goal's (dis)satisfaction
void	associate(Collection<SchedulingActivity> acts, boolean createdByThisGoal, Conflict conflict)	flags all given activities as contributing to the goal's (dis)satisfaction
Evaluation.GoalEvaluation	duplicate()	Duplicates the GoalEvaluation
Collection<SchedulingActivity>	getAssociatedActivities()	fetches the set of all activities that contributed to the evaluation
Collection<SchedulingActivity>	getInsertedActivities()	fetches the set of all activities that this goal inserted in the plan
ConflictSatisfaction	getSatisfaction()
double	getScore()	fetches the numeric evaluation score for the goal
void	removeAssociation(Collection<SchedulingActivity> acts)
void	replace(SchedulingActivity toBeReplaced, SchedulingActivity replacement)	Replaces an activity in the goal evaluation by another activity
void	setConflictSatisfaction(Conflict conflict, ConflictSatisfaction conflictSatisfaction)

Methods inherited from class java.lang.Object

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

Field Details

acts

protected final Map<SchedulingActivity,Boolean> acts

a map associating each activity that contributed to the goal to a boolean stating whether the goal created it or not

conflicts

protected final Map<Conflict,ConflictSolverResult> conflicts

Constructor Details

GoalEvaluation

public GoalEvaluation()

Method Details

getScore

public double getScore()

fetches the numeric evaluation score for the goal

Returns:

the numeric evaluation score for the goal

getSatisfaction

public ConflictSatisfaction getSatisfaction()

associate

public void associate(SchedulingActivity act,
 boolean createdByThisGoal,
 Conflict conflict)

flags given activity as contributing to the goal's (dis)satisfaction

Parameters:

act - IN the activity instance that contributed to the goal's evaluation

createdByThisGoal - IN a boolean stating whether the instance has been created by this goal or not

setConflictSatisfaction

public void setConflictSatisfaction(Conflict conflict,
 ConflictSatisfaction conflictSatisfaction)

replace

public void replace(SchedulingActivity toBeReplaced,
 SchedulingActivity replacement)

Replaces an activity in the goal evaluation by another activity

Parameters:

toBeReplaced - the activity to be replaced

replacement - the replacement activity

duplicate

public Evaluation.GoalEvaluation duplicate()

Duplicates the GoalEvaluation

Returns:

the duplicate

addConflicts

public void addConflicts(Collection<Conflict> conflict)

associate

public void associate(Collection<SchedulingActivity> acts,
 boolean createdByThisGoal,
 Conflict conflict)

flags all given activities as contributing to the goal's (dis)satisfaction

Parameters:

acts - IN container of activities that contributed to the goal's evaluation

createdByThisGoal - IN a boolean stating whether the instance has been created by this goal or not

conflict - IN a conflict if the activity has been associated to satisfy a specific conflict, can be null

removeAssociation

public void removeAssociation(Collection<SchedulingActivity> acts)

getAssociatedActivities

public Collection<SchedulingActivity> getAssociatedActivities()

fetches the set of all activities that contributed to the evaluation

Returns:

the set of all activities that contributed to the evaluation

getInsertedActivities

public Collection<SchedulingActivity> getInsertedActivities()

fetches the set of all activities that this goal inserted in the plan

Returns:

the set of all activities that this goal inserted in the plan