agi.foundation.routedesign.advanced

(agi.foundation.routedesign-2024r2.jar)

Class ParametricRouteSegment

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.advanced.ParametricRouteSegment

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class ParametricRouteSegment
extends DefinitionalObject

This takes the "Flat" geometry specified by the route and transforms it into geometry with respect to the curvature of the Ellipsoid reference surface. It represents the geometry of one RouteSegment of an overall route.

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.
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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
double	getHeading(Duration time) Get the heading at a given time since the start of the segment.
Motion1<Double>	getHeading(Duration time, int order) Get the heading and rates at a given time since the start of the segment.
Motion1<Double>	getHeight(Duration time, int order, TerrainProvider heightReference) Get the height and rates at a given time since the start of the segment.
double	getHeight(Duration time, TerrainProvider heightReference) Get the height at a given time since the start of the segment.
ProfileSegment	getProfileGeometry() Gets the vertical and temporal geometry along the SurfaceGeometry (get), parameterized on time from the start of the profile.
RouteSegment	getSegmentDefinition() Gets the definitional object specifying the behavior of this particular segment prior to propagating it with a RoutePropagator.
List<Duration>	getSpecialTimes() Gets the "special times" with respect to the beginning of the segment.
double	getSurfaceDistance() Gets the total arc-length traveled along the surface during this segment, in meters.
SurfaceSegment	getSurfaceGeometry() Gets the geometry along the SurfaceShape (get), parameterized on arc length along the surface path.
Ellipsoid	getSurfaceShape() Gets the shape of the surface upon which the path is defined.
Motion1<Cartesian>	traverseFixed(Duration time, int order) Produces the position along the route in the fixed frame of the SurfaceShape (get) as a function of time from the start of this segment of the route.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, 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

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

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 ParametricRouteSegment.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.

getSurfaceGeometry

public final SurfaceSegment getSurfaceGeometry()

Gets the geometry along the SurfaceShape (get), parameterized on arc length along the surface path.

getProfileGeometry

public final ProfileSegment getProfileGeometry()

Gets the vertical and temporal geometry along the SurfaceGeometry (get), parameterized on time from the start of the profile. This includes both height and speed along the trajectory.

getSegmentDefinition

public final RouteSegment getSegmentDefinition()

Gets the definitional object specifying the behavior of this particular segment prior to propagating it with a RoutePropagator. This can be used to identify this segment in the list of segments in a Segments (get).

traverseFixed

@Nonnull
public final Motion1<Cartesian> traverseFixed(@Nonnull
                                                        Duration time,
                                                        int order)

Produces the position along the route in the fixed frame of the SurfaceShape (get) as a function of time from the start of this segment of the route. If an order is specified, this will also produce velocity and acceleration.

The velocity and acceleration values will include the non-euclidean effects of the curvature of the SurfaceShape (get). So, while exact values for speeds and accelerations may have been specified to the RoutePropagator, the values seen here may differ due to the curvature. Values used in the RoutePropagator will tend to correspond to the equivalent speeds at the surface (ground speed). For routes operating within the Troposphere of the Earth, the differences in speed added to account for curvature will be around a few centimeters per second, depending on height above the surface.

Parameters:

time - The elapsed time, in seconds, since the start of the segment.

order - The order of derivatives requested. Zero denotes position only.

Returns:

A motion containing the position, velocity, and acceleration (depending on the order) in the fixed frame of the SurfaceShape (get).

getHeight

public final double getHeight(@Nonnull
                              Duration time,
                              @Nullable
                              TerrainProvider heightReference)

Get the height at a given time since the start of the segment.

Parameters:

time - The elapsed time, in seconds, since the start of the segment.

heightReference - The terrain reference surface to use when determining the height. The resulting height will be with respect to the local curvature of this terrain surface.

Returns:

The height with respect to the given terrain surface.

getHeight

@Nonnull
public final Motion1<Double> getHeight(@Nonnull
                                                 Duration time,
                                                 int order,
                                                 @Nullable
                                                 TerrainProvider heightReference)

Get the height and rates at a given time since the start of the segment.

Parameters:

time - The elapsed time, in seconds, since the start of the segment.

order - The order of derivatives requested. Zero denotes height only.

heightReference - The terrain reference surface to use when determining the height. The resulting height, height rate, and vertical acceleration will be with respect to the local curvature of this terrain surface.

Returns:

The height, height rate, and vertical acceleration with respect to the given terrain surface.

See Also:

ProfileSegment.getHeight(Duration,int)

getHeading

public final double getHeading(@Nonnull
                               Duration time)

Get the heading at a given time since the start of the segment.

Parameters:

time - The elapsed time, in seconds, since the start of the segment.

Returns:

The heading at the given time.

getHeading

@Nonnull
public final Motion1<Double> getHeading(@Nonnull
                                                  Duration time,
                                                  int order)

Get the heading and rates at a given time since the start of the segment.

Parameters:

time - The elapsed time, in seconds, since the start of the segment.

order - The order of derivatives requested. Zero denotes heading only.

Returns:

The heading and its rates (if available).

getSurfaceShape

public final Ellipsoid getSurfaceShape()

Gets the shape of the surface upon which the path is defined.

getSurfaceDistance

public final double getSurfaceDistance()

Gets the total arc-length traveled along the surface during this segment, in meters.

getSpecialTimes

@Nonnull
public final List<Duration> getSpecialTimes()

Gets the "special times" with respect to the beginning of the segment. These are times when the route can have discontinuities in curvature due to the connection of two different subsegments, the beginning of a turn or pitch maneuver, or because of some other behavior inside a given segment. In general, unless there is a noted HasConfigurationErrors (get) in the propagated route, these special times will generally denote the beginning and end of turns and pitch maneuvers where the route is at least C0 continuous, likely to be C1 continuous, and generally not guaranteed to be C2 continuous.

Returns:

The list of times each measured from the start of the segment where there is a special time.