agi.foundation.aircraftpropagation

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

Class VerticalBehavior

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.aircraftpropagation.VerticalBehavior

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

CruiseBehavior, LinearClimbOrDescentBehavior, MaintainHorizontalAndVerticalSpeedsBehavior, PushOverOrPullUpBehavior

public abstract class VerticalBehavior
extends DefinitionalObject

Defines the vertical behavior of a CompositeManeuver.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VerticalBehavior() Initializes a new instance.
protected	VerticalBehavior(VerticalBehavior 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(VerticalBehavior 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
abstract Evaluator<VerticalBehaviorDerivatives>	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the vertical derivatives of the maneuver.
Evaluator<VerticalBehaviorDerivatives>	getEvaluator(IServiceProvider serviceProvider) Gets an instance of an evaluator that can compute the vertical derivatives of the maneuver.
PerformanceModels	getPerformanceModels() Gets the performance models to be applied to the behavior.
WindModel	getWindModel() Gets the wind model to be used when evaluating the behavior.
void	setPerformanceModels(PerformanceModels value) Sets the performance models to be applied to the behavior.
void	setWindModel(WindModel value) Sets the wind model to be used when evaluating the behavior.
protected void	validateProperties(EvaluatorGroup group, IServiceProvider serviceProvider) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

VerticalBehavior

protected VerticalBehavior()

Initializes a new instance.

VerticalBehavior

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

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

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

getWindModel

public final WindModel getWindModel()

Gets the wind model to be used when evaluating the behavior.

setWindModel

public final void setWindModel(WindModel value)

Sets the wind model to be used when evaluating the behavior.

getPerformanceModels

public final PerformanceModels getPerformanceModels()

Gets the performance models to be applied to the behavior.

setPerformanceModels

public final void setPerformanceModels(PerformanceModels value)

Sets the performance models to be applied to the behavior.

getEvaluator

@Nonnull
public final Evaluator<VerticalBehaviorDerivatives> getEvaluator(@Nonnull
                                                                           IServiceProvider serviceProvider)

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

Parameters:

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

Returns:

The evaluator that computes the vertical derivatives of the maneuver.

Throws:

ArgumentNullException - Thrown when serviceProvider is null.

getEvaluator

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

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

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:

ArgumentNullException - Thrown when group or serviceProvider is null.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  @Nonnull
                                  IServiceProvider serviceProvider)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing VerticalBehavior.getEvaluator(EvaluatorGroup,IServiceProvider), as well as validate their own properties.

Parameters:

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

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

Throws:

ArgumentNullException - Thrown when group or serviceProvider is null.

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