agi.foundation.routedesign

(agi.foundation.routedesign-2025r1.jar)

Class PropagatedRoute

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.PropagatedRoute

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class PropagatedRoute
extends DefinitionalObject

An instance of a propagated route produced by the RoutePropagator. The propagated route indicates whether there were any configuration errors and can produce the Point representing the position along the route.

Constructor Summary

Constructors

Modifier	Constructor and Description
	PropagatedRoute(List<PropagatedRoute> propagatedRoutes) Concatenate multiple routes together.
protected	PropagatedRoute(PropagatedRoute existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(PropagatedRoute other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
Point	createPointFromRoute() Create a Point representing the position of the platform along the route expressed in the FixedFrame (get / set).
EllipsoidSurfaceCurve	createSurfaceCurve() Create a curve representing the path of this route along the surface of the CentralBody (get)'s Ellipsoid surface.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
MotionEvaluator1<Cartographic>	getCartographicEvaluator(EvaluatorGroup group) Gets an evaluator which can produce the Cartographic position along the route as a function of time.
MotionEvaluator1<Cartographic>	getCartographicEvaluator(EvaluatorGroup group, TerrainProvider heightReferenceSurface) Gets an evaluator which can produce the Cartographic position along the route as a function of time.
CentralBody	getCentralBody() Gets the central body on which this route is defined.
List<ConnectionConfigurationResult>	getConnectionConfigurationResults() Gets a list containing results for the connections where there was a problem or other metadata associated with configuration.
boolean	getHasConfigurationErrors() Gets a value indicating whether there were errors while configuring the route.
double	getOverallSurfaceDistance() Gets the overall distance along the projection of the route onto the Ellipsoid shape of the CentralBody (get).
List<ProcedureConfigurationResult>	getProcedureConfigurationResults() Gets a list containing results for procedures where there was a problem or other metadata associated with the configuration.
ParametricRouteSegment	getSegment(RouteSegment segmentDefinition) Attempts to find the parametric geometry for a particular procedure or connection segment.
List<ParametricRouteSegment>	getSegments() Gets the list of parametric segments defining the geometry of the individual pieces of the route, which together form the overall trajectory.
ArrayList<JulianDate>	getSpecialTimes() Gets a list of times of special interest along the route, such as the beginning or end of a turn or other points where the geometry changes.
JulianDate	getStart() Gets the start date of the route.
JulianDate	getStop() Gets the stop date at the end of the route.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

PropagatedRoute

public PropagatedRoute(@Nonnull
                       List<PropagatedRoute> propagatedRoutes)

Concatenate multiple routes together. Note that unless this may not create a continuous route unless the initial and final conditions were specified to match.

Parameters:

propagatedRoutes - The list of propagated route objects to combine.

PropagatedRoute

protected PropagatedRoute(@Nonnull
                          PropagatedRoute existingInstance,
                          @Nonnull
                          CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(PropagatedRoute other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the PropagatedRoute.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class DefinitionalObject

getStart

@Nonnull
public final JulianDate getStart()

Gets the start date of the route.

getStop

@Nonnull
public final JulianDate getStop()

Gets the stop date at the end of the route.

getSpecialTimes

@Nonnull
public final ArrayList<JulianDate> getSpecialTimes()

Gets a list of times of special interest along the route, such as the beginning or end of a turn or other points where the geometry changes.

Returns:

A list of times representing special points of interest along the route, such as discontinuities in the acceleration or transitions from one kind of geometry to another.

getHasConfigurationErrors

public final boolean getHasConfigurationErrors()

Gets a value indicating whether there were errors while configuring the route. If the configuration was not successful, information about where the error occurs and why can be found in the ProcedureConfigurationResults (get). Errors can mean that there are discontinuities in the route (in cases where the system was unable to find any valid trajectory) or simply represent errors where the intended behavior was infeasible due to over-defined constraints (but still may have produced a smooth route).

Returns:

True if the configuration was unable to completely configure the route and errors exist.

getOverallSurfaceDistance

public final double getOverallSurfaceDistance()

Gets the overall distance along the projection of the route onto the Ellipsoid shape of the CentralBody (get).

createSurfaceCurve

@Nonnull
public final EllipsoidSurfaceCurve createSurfaceCurve()

Create a curve representing the path of this route along the surface of the CentralBody (get)'s Ellipsoid surface.

Returns:

The path of this route along the surface.

getSegment

@Nonnull
public final ParametricRouteSegment getSegment(RouteSegment segmentDefinition)

Attempts to find the parametric geometry for a particular procedure or connection segment.

Parameters:

segmentDefinition - The RouteSegment corresponding to the requested parametric geometry generated by the RoutePropagator.

Returns:

The parametric geometry corresponding to the requested segment specified to the propagator.

Throws:

IllegalStateException - Thrown if the requested segmentDefinition does not appear in this propagated route, indicating that it was not in the list of segments used by the RoutePropagator to generate this instance.

getSegments

public final List<ParametricRouteSegment> getSegments()

Gets the list of parametric segments defining the geometry of the individual pieces of the route, which together form the overall trajectory. In general, these segments are only needed for diagnostic purposes. The position can be obtained by using PropagatedRoute.createPointFromRoute(). The surface geometry can be obtained by using PropagatedRoute.createSurfaceCurve(). Lastly, scalars are available to interpolate Heading, Height, Surface Speed, and Total Speed. So, these segments should only be used if information regarding the geometry at a specific procedure is required.

getCentralBody

public final CentralBody getCentralBody()

Gets the central body on which this route is defined.

getProcedureConfigurationResults

public final List<ProcedureConfigurationResult> getProcedureConfigurationResults()

Gets a list containing results for procedures where there was a problem or other metadata associated with the configuration. This can often occur if the geometry of surrounding procedures is infeasible or if some dynamical constraint is violated in the process of propagating a particular procedure.

getConnectionConfigurationResults

public final List<ConnectionConfigurationResult> getConnectionConfigurationResults()

Gets a list containing results for the connections where there was a problem or other metadata associated with configuration. This can often occur if the geometry of the surrounding procedures makes the geometry of a connection infeasible or if the geometry violates user specified constraints in order to connect. To avoid these cases, try allowing the surrounding procedures to adjust their heights and speeds to accommodate for the constraints on the connection.

createPointFromRoute

@Nonnull
public final Point createPointFromRoute()

Create a Point representing the position of the platform along the route expressed in the FixedFrame (get / set).

Returns:

A Point representing the position of the platform along the route.

getCartographicEvaluator

@Nonnull
public final MotionEvaluator1<Cartographic> getCartographicEvaluator(@Nonnull
                                                                               EvaluatorGroup group)

Gets an evaluator which can produce the Cartographic position along the route as a function of time. The height of the Cartographic is measured above the surface of the CentralBody (get).

Parameters:

group - The EvaluatorGroup in which to create the evaluator.

Returns:

An evaluator which produces the Cartographic position.

getCartographicEvaluator

@Nonnull
public final MotionEvaluator1<Cartographic> getCartographicEvaluator(@Nonnull
                                                                               EvaluatorGroup group,
                                                                               TerrainProvider heightReferenceSurface)

Gets an evaluator which can produce the Cartographic position along the route as a function of time.

Parameters:

group - The EvaluatorGroup in which to create the evaluator.

heightReferenceSurface - The reference surface above which to measure the height of the route

Returns:

An evaluator which produces the Cartographic position.