agi.foundation.routedesign.advanced

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

Class ConstantHeightSegment

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.advanced.ProfileSegment

agi.foundation.routedesign.advanced.ConstantHeightSegment

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ConstantHeightSegment
extends ProfileSegment

A profile defining geometry for a constant height above the reference surface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConstantHeightSegment(ConstantHeightSegment existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ConstantHeightSegment(SurfaceSegment surfacePath, double initialHorizontalSpeed, double finalHorizontalSpeed, double height, TerrainProvider heightReference) Create a new instance based on the given surface path, speed, and height.
	ConstantHeightSegment(SurfaceSegment surfacePath, double surfaceSpeed, double height, TerrainProvider heightReference) Create a new instance based on the given surface path, speed, and height.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ConstantHeightSegment other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ProfileSegment 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	getHeight(Duration time) Get the value for the height above the TerrainProvider height reference specified by the ConstantHeightSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.
Motion1<Double>	getHeight(Duration time, int order) Get the value for the height above the TerrainProvider height reference specified by the ConstantHeightSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.
TerrainProvider	getHeightReference(Duration time) Get the TerrainProvider height reference for the profile height at the given time.
double	getSurfaceMotion(Duration time) Get the value for the arc length along the surface path, in meters.
Motion1<Double>	getSurfaceMotion(Duration time, int order) Get the value for the arc length and its derivatives along the surface path, in meters and seconds.
Duration	getTotalTime() Gets the total time elapsed over the course of this segment.
Duration	getTotalTime(double arcLength) Get the time required to travel the specified arc length.

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

checkForSameDefinition, isSameDefinition

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

Constructor Detail

ConstantHeightSegment

public ConstantHeightSegment(SurfaceSegment surfacePath,
                             double surfaceSpeed,
                             double height,
                             TerrainProvider heightReference)

Create a new instance based on the given surface path, speed, and height.

Parameters:

surfacePath - The surface path over which to define the profile.

surfaceSpeed - The speed at which to move along the path, in meters per second.

height - The height above the heightReference, in meters.

heightReference - The reference surface with respect to which the constant height is defined.

ConstantHeightSegment

public ConstantHeightSegment(SurfaceSegment surfacePath,
                             double initialHorizontalSpeed,
                             double finalHorizontalSpeed,
                             double height,
                             TerrainProvider heightReference)

Create a new instance based on the given surface path, speed, and height.

Parameters:

surfacePath - The surface path over which to define the profile.

initialHorizontalSpeed - The initial speed along the path, in meters per second.

finalHorizontalSpeed - The final speed along the path, in meters per second.

height - The height above the heightReference, in meters.

heightReference - The reference surface with respect to which the constant height is defined.

ConstantHeightSegment

protected ConstantHeightSegment(@Nonnull
                                ConstantHeightSegment 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(ProfileSegment 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 ProfileSegment

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

Overrides:

computeCurrentDefinitionHashCode in class ProfileSegment

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.

getHeight

public double getHeight(@Nonnull
                        Duration time)

Get the value for the height above the TerrainProvider height reference specified by the ConstantHeightSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.

Overrides:

getHeight in class ProfileSegment

Parameters:

time - The time elapsed since the beginning of this segment.

Returns:

The height above the reference, in meters.

getHeight

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

Get the value for the height above the TerrainProvider height reference specified by the ConstantHeightSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.

Specified by:

getHeight in class ProfileSegment

Parameters:

time - The time elapsed since the beginning of this segment.

order - The requested order of the height where zero is the height and higher orders specify the number of derivatives. Depending on the type of profile and underlying geometry, the resulting order may not match the requested order.

Returns:

The height above the reference, in meters, and its derivatives.

getSurfaceMotion

public double getSurfaceMotion(@Nonnull
                               Duration time)

Get the value for the arc length along the surface path, in meters.

Overrides:

getSurfaceMotion in class ProfileSegment

Parameters:

time - The time elapsed since the beginning of this segment.

Returns:

The arc length along the surface path, in meters.

getSurfaceMotion

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

Get the value for the arc length and its derivatives along the surface path, in meters and seconds.

Specified by:

getSurfaceMotion in class ProfileSegment

Parameters:

time - The time elapsed since the beginning of this segment.

order - The requested order of the arc length where zero is the arc length and higher orders specify the number of derivatives. Depending on the type of profile and underlying geometry, the resulting order may not match the requested order.

Returns:

The arc length along the surface, in meters, and its derivatives.

getTotalTime

@Nonnull
public Duration getTotalTime()

Gets the total time elapsed over the course of this segment.

Specified by:

getTotalTime in class ProfileSegment

getTotalTime

@Nonnull
public Duration getTotalTime(double arcLength)

Get the time required to travel the specified arc length.

Specified by:

getTotalTime in class ProfileSegment

Parameters:

arcLength - The arc length to travel, in meters.

Returns:

The elapsed time at the specified point along the surface path.

getHeightReference

public TerrainProvider getHeightReference(@Nonnull
                                          Duration time)

Get the TerrainProvider height reference for the profile height at the given time.

Specified by:

getHeightReference in class ProfileSegment

Parameters:

time - The elapsed time since the beginning of this segment.

Returns:

The terrain reference surface above which the height is defined.