agi.foundation.aircraftpropagation

(agi.foundation.aircraftpropagation-2023r1.jar)

Class CruiseBehavior

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.aircraftpropagation.VerticalBehavior

agi.foundation.aircraftpropagation.CruiseBehavior

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class CruiseBehavior
extends VerticalBehavior

Defines a vertical behavior of a CompositeManeuver in which an aircraft attempts to achieve cruising flight at a desired altitude.

Constructor Summary

Constructors

Constructor and Description
CruiseBehavior() Initializes a new instance.
CruiseBehavior(TerrainProvider heightReferenceSurface) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(VerticalBehavior 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.
ValueDefinition<Double>	getAltitude() Gets the desired cruise altitude with respect to the HeightReferenceSurface (get / set).
Evaluator<VerticalBehaviorDerivatives>	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the vertical derivatives of the maneuver.
TerrainProvider	getHeightReferenceSurface() Gets the reference surface above which the Altitude (get / set) is defined.
ValueDefinition<Double>	getLevelOffAltitudeBandAboveCruise() Gets the altitude range above the desired cruise altitude where the aircraft will transition from descending flight to cruising flight.
ValueDefinition<Double>	getLevelOffAltitudeBandBelowCruise() Gets the altitude range below the desired cruise altitude where the aircraft will transition from climbing flight to cruising flight.
ValueDefinition<Double>	getTimeConstant() Gets the time constant in seconds.
void	setAltitude(ValueDefinition<Double> value) Sets the desired cruise altitude with respect to the HeightReferenceSurface (get / set).
void	setHeightReferenceSurface(TerrainProvider value) Sets the reference surface above which the Altitude (get / set) is defined.
void	setLevelOffAltitudeBandAboveCruise(ValueDefinition<Double> value) Sets the altitude range above the desired cruise altitude where the aircraft will transition from descending flight to cruising flight.
void	setLevelOffAltitudeBandBelowCruise(ValueDefinition<Double> value) Sets the altitude range below the desired cruise altitude where the aircraft will transition from climbing flight to cruising flight.
void	setTimeConstant(ValueDefinition<Double> value) Sets the time constant in seconds.

Methods inherited from class agi.foundation.aircraftpropagation.VerticalBehavior

checkForSameDefinition, 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

CruiseBehavior

public CruiseBehavior()

Initializes a new instance. TimeConstant (get / set) will be set to 1 second and HeightReferenceSurface (get / set) will be set to the MeanSeaLevel (get / set) property of the EarthCentralBody, which must be configured before using this type.

CruiseBehavior

public CruiseBehavior(TerrainProvider heightReferenceSurface)

Initializes a new instance. TimeConstant (get / set) will be set to 1 second.

Parameters:

heightReferenceSurface - The reference surface above which the Altitude (get / set) is defined.

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

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

Overrides:

computeCurrentDefinitionHashCode in class VerticalBehavior

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 VerticalBehavior

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getAltitude

public final ValueDefinition<Double> getAltitude()

Gets the desired cruise altitude with respect to the HeightReferenceSurface (get / set).

setAltitude

public final void setAltitude(ValueDefinition<Double> value)

Sets the desired cruise altitude with respect to the HeightReferenceSurface (get / set).

getLevelOffAltitudeBandAboveCruise

public final ValueDefinition<Double> getLevelOffAltitudeBandAboveCruise()

Gets the altitude range above the desired cruise altitude where the aircraft will transition from descending flight to cruising flight.

setLevelOffAltitudeBandAboveCruise

public final void setLevelOffAltitudeBandAboveCruise(ValueDefinition<Double> value)

Sets the altitude range above the desired cruise altitude where the aircraft will transition from descending flight to cruising flight.

getLevelOffAltitudeBandBelowCruise

public final ValueDefinition<Double> getLevelOffAltitudeBandBelowCruise()

Gets the altitude range below the desired cruise altitude where the aircraft will transition from climbing flight to cruising flight.

setLevelOffAltitudeBandBelowCruise

public final void setLevelOffAltitudeBandBelowCruise(ValueDefinition<Double> value)

Sets the altitude range below the desired cruise altitude where the aircraft will transition from climbing flight to cruising flight.

getTimeConstant

public final ValueDefinition<Double> getTimeConstant()

Gets the time constant in seconds.

setTimeConstant

public final void setTimeConstant(ValueDefinition<Double> value)

Sets the time constant in seconds.

getHeightReferenceSurface

public final TerrainProvider getHeightReferenceSurface()

Gets the reference surface above which the Altitude (get / set) is defined.

setHeightReferenceSurface

public final void setHeightReferenceSurface(TerrainProvider value)

Sets the reference surface above which the Altitude (get / set) is defined.

getEvaluator

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

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

Specified by:

getEvaluator in class VerticalBehavior

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 vertical derivatives of the maneuver.

Throws:

PropertyInvalidException - Thrown when the property WindModel (get / set), PerformanceModels (get / set), Altitude (get / set), LevelOffAltitudeBandAboveCruise (get / set), LevelOffAltitudeBandBelowCruise (get / set), TimeConstant (get / set), or HeightReferenceSurface (get / set) is null.

ArgumentNullException - Thrown when group or serviceProvider is null.