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

Class ActivityExistentialGoal.Builder<T extends ActivityExistentialGoal.Builder<T>>

java.lang.Object

gov.nasa.jpl.aerie.scheduler.goals.Goal.Builder<T>

gov.nasa.jpl.aerie.scheduler.goals.ActivityExistentialGoal.Builder<T>

Direct Known Subclasses:

ActivityTemplateGoal.Builder, ProceduralCreationGoal.Builder

Enclosing class:

ActivityExistentialGoal

public abstract static class ActivityExistentialGoal.Builder<T extends ActivityExistentialGoal.Builder<T>>
extends Goal.Builder<T>

the builder can construct goals piecemeal via a series of method calls

Field Summary

Fields

Modifier and Type	Field	Description
protected ChildCustody	childCustody

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

ending, name, planHorizon, range, resourceConstraints, starting

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ActivityExistentialGoal	build()	uses all pending specifications to construct a matching new goal object this is typically the last client call after a chain of specifiers, but the builder object remains viable to be further specified and build additional goals
protected ActivityExistentialGoal	fill(ActivityExistentialGoal goal)	populates the provided goal with specifiers from this builder and above typically called by any derived builder classes to fill in the specifiers managed at this builder level and above
T	owned(ChildCustody custody)	sets the activity instance sharing preference for the goal this specifier is optional (the default is Jointly).

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

attachStateConstraint, endingAt, fill, forAllTimeIn, getThis, named, shouldRollbackIfUnsatisfied, simulateAfter, startingAt, withinPlanHorizon

Methods inherited from class java.lang.Object

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

Field Details

childCustody

protected ChildCustody childCustody

Constructor Details

Builder

public Builder()

Method Details

owned

public T owned(ChildCustody custody)

sets the activity instance sharing preference for the goal this specifier is optional (the default is Jointly). it replaces any previous specification.

Parameters:

custody - IN the custody strategy for the goal to adopt

Returns:

this builder, ready for additional specification

build

public ActivityExistentialGoal build()

uses all pending specifications to construct a matching new goal object this is typically the last client call after a chain of specifiers, but the builder object remains viable to be further specified and build additional goals

Overrides:

build in class Goal.Builder<T extends ActivityExistentialGoal.Builder<T>>

Returns:

a newly allocated goal object matching all specifications

fill

protected ActivityExistentialGoal fill(ActivityExistentialGoal goal)

populates the provided goal with specifiers from this builder and above typically called by any derived builder classes to fill in the specifiers managed at this builder level and above

Parameters:

goal - IN/OUT a goal object to be filled with specifiers from this level of builder and above

Returns:

the provided goal object, with details filled in