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

Class ActivityTemplateGoal.Builder<T extends ActivityTemplateGoal.Builder<T>>

java.lang.Object

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

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

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

Direct Known Subclasses:

CardinalityGoal.Builder, CoexistenceGoal.Builder, RecurrenceGoal.Builder

Enclosing class:

ActivityTemplateGoal

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ActivityExpression	matchingActTemplate
protected ActivityExpression	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
ActivityTemplateGoal	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 ActivityTemplateGoal	fill(ActivityTemplateGoal 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	match(ActivityExpression expression)
T	thereExistsOne(ActivityExpression template)	specifies the activity that must exist, and how to create it if necessary this specifier is required.

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, 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

thereExists

protected ActivityExpression thereExists

matchingActTemplate

protected ActivityExpression matchingActTemplate

Constructor Details

Builder

public Builder()

Method Details

thereExistsOne

public T thereExistsOne(ActivityExpression template)

specifies the activity that must exist, and how to create it if necessary this specifier is required. it replaces any previous specification.

Parameters:

template - IN a pattern for matching satisfying activity instances with the ability to create new instances if necessary

Returns:

this builder, ready for additional specification

match

public T match(ActivityExpression expression)

build

public ActivityTemplateGoal 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 ActivityExistentialGoal.Builder<T extends ActivityTemplateGoal.Builder<T>>

Returns:

a newly allocated goal object matching all specifications

fill

protected ActivityTemplateGoal fill(ActivityTemplateGoal 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