agi.foundation.routedesign.advanced

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

Class SurfaceCurveSegment

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.advanced.SurfaceSegment

agi.foundation.routedesign.advanced.SurfaceCurveSegment

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SurfaceCurveSegment
extends SurfaceSegment

A surface segment representing the path defined by an EllipsoidSurfaceCurve. Most commonly, this is used with either an EllipsoidRhumbLine (constant heading) or an EllipsoidGeodesic (shortest distance).

Constructor Summary

Constructors

Modifier	Constructor and Description
	SurfaceCurveSegment(EllipsoidSurfaceCurve surfaceCurve) Create a new instance based on the given surface curve.
protected	SurfaceCurveSegment(SurfaceCurveSegment 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(SurfaceCurveSegment other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SurfaceSegment 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 CartographicExtent	computeCartographicExtent() Computes the latitude and longitude boundary surrounding this segment.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
EllipsoidSurfaceCurve	createSurfaceCurve() Create an EllipsoidSurfaceCurve which represents this segment of a route along the surface.
double	getFinalHeading() Gets the final heading measured eastward from north, in radians.
Cartographic	getFinalSurfacePoint() Gets the final position at the end of the surface segment.
double	getHeading(double distanceAlongPath) Get the heading measured clockwise from local north, in radians.
Motion1<Double>	getHeading(Motion1<Double> distanceAlongPath, int order) Get the heading and its derivatives, in radians and radians/meter.
double	getInitialHeading() Gets the initial heading measured eastward from north, in radians.
Cartographic	getInitialSurfacePoint() Gets the initial position at the start of the surface segment.
double[]	getTransitionPoints() Gets the arc lengths, in meters, at which the geometry changes behavior.
Cartesian	traverseFixed(double distanceAlongPath) Get the surface position in the fixed frame of the SurfaceShape (get / set) at the specified distance along the surface path.
Cartographic	traverseSurface(double distanceAlongPath) Get the surface position at the specified distance along the surface path.

Methods inherited from class agi.foundation.routedesign.advanced.SurfaceSegment

checkForSameDefinition, getSurfaceDistance, getSurfaceShape, isSameDefinition, setSurfaceDistance, setSurfaceShape

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

Constructor Detail

SurfaceCurveSegment

public SurfaceCurveSegment(EllipsoidSurfaceCurve surfaceCurve)

Create a new instance based on the given surface curve.

Parameters:

surfaceCurve - The surface curve that specifies the path along the surface.

SurfaceCurveSegment

protected SurfaceCurveSegment(@Nonnull
                              SurfaceCurveSegment 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(SurfaceSegment 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 SurfaceSegment

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(SurfaceCurveSegment 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 SurfaceCurveSegment.checkForSameDefinition(agi.foundation.routedesign.advanced.SurfaceSegment) method.

Overrides:

computeCurrentDefinitionHashCode in class SurfaceSegment

Returns:

The computed hash code.

traverseFixed

@Nonnull
public Cartesian traverseFixed(double distanceAlongPath)

Get the surface position in the fixed frame of the SurfaceShape (get / set) at the specified distance along the surface path.

Overrides:

traverseFixed in class SurfaceSegment

Parameters:

distanceAlongPath - The distance along the path, in meters.

Returns:

The fixed surface position of the path at the specified distance.

getHeading

public double getHeading(double distanceAlongPath)

Get the heading measured clockwise from local north, in radians.

Overrides:

getHeading in class SurfaceSegment

Parameters:

distanceAlongPath - The distance along the surface path, in meters.

Returns:

The heading at the given position along the path.

getHeading

@Nonnull
public Motion1<Double> getHeading(@Nonnull
                                            Motion1<Double> distanceAlongPath,
                                            int order)

Get the heading and its derivatives, in radians and radians/meter.

Note that the units for the derivatives here are in radians and meters. To get the time rates of change of heading, use the chain rule with the time rate of change of the arc length parameter.

Specified by:

getHeading in class SurfaceSegment

Parameters:

distanceAlongPath - The distance along the surface path, in meters.

order - The requested order indicating the number of derivatives to compute.

Returns:

The heading and its derivatives, in radians and radians/meter.

traverseSurface

@Nonnull
public Cartographic traverseSurface(double distanceAlongPath)

Get the surface position at the specified distance along the surface path.

Specified by:

traverseSurface in class SurfaceSegment

Parameters:

distanceAlongPath - The distance along the surface path, in meters.

Returns:

The Cartographic position at the given distance along the path.

getTransitionPoints

public double[] getTransitionPoints()

Gets the arc lengths, in meters, at which the geometry changes behavior. This could represent discontinuities in the route in one or more derivatives or other points of interest.

Specified by:

getTransitionPoints in class SurfaceSegment

getInitialSurfacePoint

@Nonnull
public Cartographic getInitialSurfacePoint()

Gets the initial position at the start of the surface segment.

Overrides:

getInitialSurfacePoint in class SurfaceSegment

getFinalSurfacePoint

@Nonnull
public Cartographic getFinalSurfacePoint()

Gets the final position at the end of the surface segment.

Overrides:

getFinalSurfacePoint in class SurfaceSegment

getInitialHeading

public double getInitialHeading()

Gets the initial heading measured eastward from north, in radians.

Overrides:

getInitialHeading in class SurfaceSegment

getFinalHeading

public double getFinalHeading()

Gets the final heading measured eastward from north, in radians.

Overrides:

getFinalHeading in class SurfaceSegment

createSurfaceCurve

public EllipsoidSurfaceCurve createSurfaceCurve()

Create an EllipsoidSurfaceCurve which represents this segment of a route along the surface.

Overrides:

createSurfaceCurve in class SurfaceSegment

Returns:

A surface curve representing this segment of the route along the surface.

computeCartographicExtent

protected CartographicExtent computeCartographicExtent()

Computes the latitude and longitude boundary surrounding this segment.

Overrides:

computeCartographicExtent in class SurfaceSegment

Returns:

A CartographicExtent that bounds this surface segment.