agi.foundation.aircraftpropagation

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

Class MaintainCourseOrHeadingBehavior

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.aircraftpropagation.HorizontalBehavior

agi.foundation.aircraftpropagation.MaintainCourseOrHeadingBehavior

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class MaintainCourseOrHeadingBehavior
extends HorizontalBehavior

Defines a horizontal behavior of a CompositeManeuver in which a constant course or heading is maintained. If the ManeuverReferenceAxes (get / set) is AircraftPropagation.ManeuverReferenceAxes#STATIC_ATMOSPHERE, then the true course of the aircraft is maintained. If the ManeuverReferenceAxes (get / set) is AircraftPropagation.ManeuverReferenceAxes#MOVING_ATMOSPHERE, then the true heading of the aircraft is maintained.

Constructor Summary

Constructors

Constructor and Description
MaintainCourseOrHeadingBehavior() Initializes an instance with the static atmosphere as the ManeuverReferenceAxes (get / set) such that the true course of the aircraft is maintained.
MaintainCourseOrHeadingBehavior(ManeuverReferenceAxes maneuverReferenceAxes) Initializes an instance with the provided ManeuverReferenceAxes (get / set).

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(HorizontalBehavior 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.
Evaluator<HorizontalBehaviorDerivatives>	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the horizontal derivatives of the maneuver.
ManeuverReferenceAxes	getManeuverReferenceAxes() Gets the reference axes for the behavior.
void	setManeuverReferenceAxes(ManeuverReferenceAxes value) Sets the reference axes for the behavior.

Methods inherited from class agi.foundation.aircraftpropagation.HorizontalBehavior

checkForSameDefinition, enumerateDependencies, getEvaluator, getPerformanceModels, getWindModel, setPerformanceModels, setWindModel, validateProperties

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

MaintainCourseOrHeadingBehavior

public MaintainCourseOrHeadingBehavior()

Initializes an instance with the static atmosphere as the ManeuverReferenceAxes (get / set) such that the true course of the aircraft is maintained.

MaintainCourseOrHeadingBehavior

public MaintainCourseOrHeadingBehavior(@Nonnull
                                       ManeuverReferenceAxes maneuverReferenceAxes)

Initializes an instance with the provided ManeuverReferenceAxes (get / set).

If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then the true course of the aircraft is maintained. If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then the true heading of the aircraft is maintained.

Parameters:

maneuverReferenceAxes - The reference axes for the behavior.

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(HorizontalBehavior 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 HorizontalBehavior

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 MaintainCourseOrHeadingBehavior.checkForSameDefinition(agi.foundation.aircraftpropagation.HorizontalBehavior) method.

Overrides:

computeCurrentDefinitionHashCode in class HorizontalBehavior

Returns:

The computed hash code.

getManeuverReferenceAxes

@Nonnull
public final ManeuverReferenceAxes getManeuverReferenceAxes()

Gets the reference axes for the behavior.

If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then the true course of the aircraft is maintained. If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then the true heading of the aircraft is maintained.

setManeuverReferenceAxes

public final void setManeuverReferenceAxes(@Nonnull
                                           ManeuverReferenceAxes value)

Sets the reference axes for the behavior.

If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then the true course of the aircraft is maintained. If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then the true heading of the aircraft is maintained.

getEvaluator

public Evaluator<HorizontalBehaviorDerivatives> getEvaluator(EvaluatorGroup group,
                                                             IServiceProvider serviceProvider)

Gets an instance of an evaluator that can compute the horizontal derivatives of the maneuver.

Specified by:

getEvaluator in class HorizontalBehavior

Parameters:

group - The group in which to create the evaluator and its dependents.

serviceProvider - A service provider which must provide the ILocationPointService service.

Returns:

The evaluator that computes the horizontal derivatives of the maneuver.

Throws:

ArgumentNullException - Thrown when the parameter group or serviceProvider is null.

PropertyInvalidException - Thrown when the property WindModel (get / set) or PerformanceModels (get / set) is null.

UnsupportedCaseException - Thrown if the ManeuverReferenceAxes (get / set) is not valid.

ArgumentNullException - Thrown when group or serviceProvider is null.