public final class MaintainHorizontalAndVerticalSpeedsBehavior extends VerticalBehavior
CompositeManeuver in which the horizontal and vertical speeds are maintained.
If the ManeuverReferenceAxes (get / set) is AircraftPropagation.ManeuverReferenceAxes#STATIC_ATMOSPHERE, then speeds relative to the static atmosphere are maintained.
If the ManeuverReferenceAxes (get / set) is AircraftPropagation.ManeuverReferenceAxes#MOVING_ATMOSPHERE, then speeds relative to the moving atmosphere are maintained.| Constructor and Description |
|---|
MaintainHorizontalAndVerticalSpeedsBehavior()
|
MaintainHorizontalAndVerticalSpeedsBehavior(ManeuverReferenceAxes maneuverReferenceAxes)
|
| 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.
|
Evaluator<VerticalBehaviorDerivatives> |
getEvaluator(EvaluatorGroup group,
IServiceProvider serviceProvider)
Gets an instance of an evaluator that can compute the vertical derivatives of the maneuver.
|
ManeuverReferenceAxes |
getManeuverReferenceAxes()
Gets the reference axes for the behavior.
|
void |
setManeuverReferenceAxes(ManeuverReferenceAxes value)
Sets the reference axes for the behavior.
|
checkForSameDefinition, enumerateDependencies, getEvaluator, getPerformanceModels, getWindModel, setPerformanceModels, setWindModel, validatePropertiesareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic MaintainHorizontalAndVerticalSpeedsBehavior()
public MaintainHorizontalAndVerticalSpeedsBehavior(@Nonnull ManeuverReferenceAxes maneuverReferenceAxes)
ManeuverReferenceAxes (get / set).
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then speeds relative to the static atmosphere are maintained.
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then speeds relative to the moving atmosphere are maintained.
maneuverReferenceAxes - The reference axes for the behavior.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected boolean checkForSameDefinition(VerticalBehavior other)
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).checkForSameDefinition in class VerticalBehaviorother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
MaintainHorizontalAndVerticalSpeedsBehavior.checkForSameDefinition(agi.foundation.aircraftpropagation.VerticalBehavior) method.computeCurrentDefinitionHashCode in class VerticalBehavior@Nonnull public final ManeuverReferenceAxes getManeuverReferenceAxes()
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then speeds relative to the static atmosphere are maintained.
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then speeds relative to the moving atmosphere are maintained.
public final void setManeuverReferenceAxes(@Nonnull ManeuverReferenceAxes value)
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.STATIC_ATMOSPHERE, then speeds relative to the static atmosphere are maintained.
If the ManeuverReferenceAxes (get / set) is ManeuverReferenceAxes.MOVING_ATMOSPHERE, then speeds relative to the moving atmosphere are maintained.
public Evaluator<VerticalBehaviorDerivatives> getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider)
getEvaluator in class VerticalBehaviorgroup - The group in which to create the evaluator and its dependents.serviceProvider - A service provider which must provide the ILocationPointService service.ArgumentNullException - Thrown when 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.