agi.foundation.routedesign.advanced

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

Class ProfileSegment

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.routedesign.advanced.ProfileSegment

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

CompositeProfileSegment, ConstantHeightSegment, StandardTransitionProfileSegment

public abstract class ProfileSegment
extends DefinitionalObject

Base class for all types representing the immutable vertical and temporal geometry corresponding to all or part of a particular RouteSegment.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProfileSegment() Initializes a new instance.
protected	ProfileSegment(ProfileSegment 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 abstract boolean	checkForSameDefinition(ProfileSegment other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
double	getHeight(Duration time) Get the value for the height above the TerrainProvider height reference specified by the ProfileSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.
abstract Motion1<Double>	getHeight(Duration time, int order) Get the value for the height above the TerrainProvider height reference specified by the ProfileSegment.getHeightReference(agi.foundation.time.Duration) method at the given time.
abstract 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.
abstract 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.
abstract Duration	getTotalTime() Gets the total time elapsed over the course of this segment.
abstract Duration	getTotalTime(double arcLength) Get the time required to travel the specified arc length.
boolean	isSameDefinition(ProfileSegment other) Determines if this object has the same definition as another object.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

ProfileSegment

protected ProfileSegment()

Initializes a new instance.

ProfileSegment

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

isSameDefinition

public final boolean isSameDefinition(ProfileSegment other)

Determines if this object has the same definition as another object.

This method is very similar to Object.equals(Object) except that it explicitly considers the "definitions" of the two objects for objects that do not typically act like values. The definition of an object typically includes all of the fields of the object.

Parameters:

other - The other instance to compare to this one.

Returns:

true if this object has the same definition as the specified one. false if the other object is null, a different type than this one, or if this object and the specified one have different definitions.

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

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 ProfileSegment.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getHeight

public double getHeight(@Nonnull
                        Duration time)

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

Parameters:

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

Returns:

The height above the reference, in meters.

getHeight

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

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

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.

Parameters:

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

Returns:

The arc length along the surface path, in meters.

getSurfaceMotion

@Nonnull
public abstract 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.

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 abstract Duration getTotalTime(double arcLength)

Get the time required to travel the specified arc length.

Parameters:

arcLength - The arc length to travel, in meters.

Returns:

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

getTotalTime

@Nonnull
public abstract Duration getTotalTime()

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

getHeightReference

public abstract TerrainProvider getHeightReference(@Nonnull
                                                   Duration time)

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

Parameters:

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

Returns:

The terrain reference surface above which the height is defined.