agi.foundation.aircraftpropagation

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

Class CruisePerformanceModel

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.aircraftpropagation.CruisePerformanceModel

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

BandedCruisePerformanceModel, SimpleCruisePerformanceModel

public abstract class CruisePerformanceModel
extends DefinitionalObject

Defines an aircraft's performance model during cruise, by determining a set of CruiseCommandedValues at a given time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CruisePerformanceModel() Initializes a new instance.
protected	CruisePerformanceModel(CruisePerformanceModel existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(CruisePerformanceModel other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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 int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract Evaluator<CruiseCommandedValues>	getEvaluator(EvaluatorGroup group, IServiceProvider serviceProvider) Gets an evaluator for the commanded values during cruise for a given aircraft.
Evaluator<CruiseCommandedValues>	getEvaluator(IServiceProvider serviceProvider) Gets an evaluator for the commanded values during cruise for a given aircraft.
ScalarDependentOnServiceProvider	getScalarElement(CruiseCommandedValuesElement element) Gets a ScalarDependentOnServiceProvider that will represent one of the individual commanded values computed by this performance model.

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

CruisePerformanceModel

protected CruisePerformanceModel()

Initializes a new instance.

CruisePerformanceModel

protected CruisePerformanceModel(@Nonnull
                                 CruisePerformanceModel 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(CruisePerformanceModel 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 CruisePerformanceModel.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getEvaluator

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

Gets an evaluator for the commanded values during cruise for a given aircraft.

Parameters:

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

Returns:

An evaluator for the commanded values.

getEvaluator

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

Gets an evaluator for the commanded values during cruise for a given aircraft.

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

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

Returns:

An evaluator for the commanded values.

getScalarElement

@Nonnull
public final ScalarDependentOnServiceProvider getScalarElement(@Nonnull
                                                                         CruiseCommandedValuesElement element)

Gets a ScalarDependentOnServiceProvider that will represent one of the individual commanded values computed by this performance model. The scalar will require that the service provider must provide the ILocationPointService service.

Parameters:

element - The commanded value to compute.

Returns:

A ScalarDependentOnServiceProvider that represents an individual commanded value from this performance model.