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

Class CoexistenceGoal.Builder

java.lang.Object

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

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

gov.nasa.jpl.aerie.scheduler.goals.ActivityTemplateGoal.Builder<CoexistenceGoal.Builder>

gov.nasa.jpl.aerie.scheduler.goals.CoexistenceGoal.Builder

Enclosing class:

CoexistenceGoal

public static class CoexistenceGoal.Builder
extends ActivityTemplateGoal.Builder<CoexistenceGoal.Builder>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected TimeExpressionRelative	endExpr
protected gov.nasa.jpl.aerie.constraints.tree.Expression<gov.nasa.jpl.aerie.constraints.time.Spans>	forEach
protected TimeExpressionRelative	startExpr

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

matchingActTemplate, thereExists

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

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
CoexistenceGoal.Builder	aliasForAnchors(String alias)
CoexistenceGoal	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
CoexistenceGoal.Builder	createPersistentAnchor(PersistentTimeAnchor persistentAnchor)
CoexistenceGoal.Builder	endsAfterEnd()
CoexistenceGoal.Builder	endsAt(TimeAnchor anchor)
CoexistenceGoal.Builder	endsAt(TimeExpressionRelative TimeExpressionRelative)
CoexistenceGoal.Builder	endsBefore(TimeExpressionRelative expr)
CoexistenceGoal.Builder	endsBeforeEnd()
protected CoexistenceGoal	fill(CoexistenceGoal 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
CoexistenceGoal.Builder	forEach(gov.nasa.jpl.aerie.constraints.tree.Expression<gov.nasa.jpl.aerie.constraints.time.Spans> expression)
protected CoexistenceGoal.Builder	getThis()	returns the current builder object (but typed at the lowest level) should be implemented by the builder at the bottom of the type heirarchy
CoexistenceGoal.Builder	startsAfterEnd()
CoexistenceGoal.Builder	startsAfterStart()
CoexistenceGoal.Builder	startsAt(TimeAnchor anchor)
CoexistenceGoal.Builder	startsAt(TimeExpressionRelative TimeExpressionRelative)

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

fill, match, thereExistsOne

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

fill, owned

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

attachStateConstraint, endingAt, fill, forAllTimeIn, 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

forEach

protected gov.nasa.jpl.aerie.constraints.tree.Expression<gov.nasa.jpl.aerie.constraints.time.Spans> forEach

startExpr

protected TimeExpressionRelative startExpr

endExpr

protected TimeExpressionRelative endExpr

Constructor Details

Builder

public Builder()

Method Details

forEach

public CoexistenceGoal.Builder forEach(gov.nasa.jpl.aerie.constraints.tree.Expression<gov.nasa.jpl.aerie.constraints.time.Spans> expression)

startsAt

public CoexistenceGoal.Builder startsAt(TimeExpressionRelative TimeExpressionRelative)

endsAt

public CoexistenceGoal.Builder endsAt(TimeExpressionRelative TimeExpressionRelative)

startsAt

public CoexistenceGoal.Builder startsAt(TimeAnchor anchor)

endsAt

public CoexistenceGoal.Builder endsAt(TimeAnchor anchor)

endsBefore

public CoexistenceGoal.Builder endsBefore(TimeExpressionRelative expr)

startsAfterEnd

public CoexistenceGoal.Builder startsAfterEnd()

startsAfterStart

public CoexistenceGoal.Builder startsAfterStart()

endsBeforeEnd

public CoexistenceGoal.Builder endsBeforeEnd()

endsAfterEnd

public CoexistenceGoal.Builder endsAfterEnd()

aliasForAnchors

public CoexistenceGoal.Builder aliasForAnchors(String alias)

createPersistentAnchor

public CoexistenceGoal.Builder createPersistentAnchor(PersistentTimeAnchor persistentAnchor)

build

public CoexistenceGoal 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 ActivityTemplateGoal.Builder<CoexistenceGoal.Builder>

Returns:

a newly allocated goal object matching all specifications

getThis

protected CoexistenceGoal.Builder getThis()

returns the current builder object (but typed at the lowest level) should be implemented by the builder at the bottom of the type heirarchy

Specified by:

getThis in class Goal.Builder<CoexistenceGoal.Builder>

Returns:

reference to the current builder object (specifically typed)

fill

protected CoexistenceGoal fill(CoexistenceGoal 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 object, with details filled in