SimpleForwardFlightPropellerPropulsion

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.aircraftpropagation.SimpleForwardFlightPropellerPropulsion

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable
```
public final class SimpleForwardFlightPropellerPropulsion
extends DefinitionalObject
```
Defines a propulsion model for a propeller driven fixed wing aircraft under nominal forward flight conditions.

Constructor Summary

Constructors
Constructor and Description
`SimpleForwardFlightPropellerPropulsion()` Initializes a new instance.
`SimpleForwardFlightPropellerPropulsion(SimpleForwardFlightPropellerPropulsion existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`ScalarDependentOnServiceProvider`	`getDensity()` Gets the scalar defining the local atmospheric density.
`ScalarDependentOnServiceProvider`	`getDensityRatio()` Gets the scalar defining the ratio of the local atmospheric density to a reference density (usually standard mean sea level density).
`Scalar`	`getFuelFlowRate()` Gets the fuel flow rate.
`Bounds`	`getFuelFlowRateLimits()` Gets the fuel flow rate limits, typically defined at nominal sea level atmospheric density.
`Bounds`	`getPowerAvailableLimits()` Gets the available power limits, typically defined at nominal sea level atmospheric density.
`ValueDefinition<Double>`	`getPowerDropOffParameter()` Gets the constant used in the computation of the Gagg-Farrar power drop off factor.
`Scalar`	`getPowerRequired()` Gets the power required.
`int`	`getPropellerCount()` Gets the number of propellers for the propulsion model.
`ValueDefinition<Double>`	`getPropellerRadius()` Gets the radius of the propellers.
`Point`	`getReferencePoint()` Gets the point at which the propulsion model is to be applied.
`VectorDependentOnServiceProvider`	`getRelativeVelocity()` Gets the velocity vector relative to the atmosphere.
`Scalar`	`getThrottleSetting()` Gets the throttle setting.
`Scalar`	`getThrustRequired()` Gets the required thrust.
`void`	`setDensity(ScalarDependentOnServiceProvider value)` Sets the scalar defining the local atmospheric density.
`void`	`setDensityRatio(ScalarDependentOnServiceProvider value)` Sets the scalar defining the ratio of the local atmospheric density to a reference density (usually standard mean sea level density).
`void`	`setFuelFlowRateLimits(Bounds value)` Sets the fuel flow rate limits, typically defined at nominal sea level atmospheric density.
`void`	`setPowerAvailableLimits(Bounds value)` Sets the available power limits, typically defined at nominal sea level atmospheric density.
`void`	`setPowerDropOffParameter(ValueDefinition<Double> value)` Sets the constant used in the computation of the Gagg-Farrar power drop off factor.
`void`	`setPropellerCount(int value)` Sets the number of propellers for the propulsion model.
`void`	`setPropellerRadius(ValueDefinition<Double> value)` Sets the radius of the propellers.
`void`	`setReferencePoint(Point value)` Sets the point at which the propulsion model is to be applied.
`void`	`setRelativeVelocity(VectorDependentOnServiceProvider value)` Sets the velocity vector relative to the atmosphere.
`void`	`setThrustRequired(Scalar value)` Sets the required thrust.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleForwardFlightPropellerPropulsion
```
public SimpleForwardFlightPropellerPropulsion()
```
    Initializes a new instance.
  - SimpleForwardFlightPropellerPropulsion
```
public SimpleForwardFlightPropellerPropulsion(@Nonnull
                                              SimpleForwardFlightPropellerPropulsion 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
  - 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(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.
  - 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 SimpleForwardFlightPropellerPropulsion.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.
  - getReferencePoint
```
public final Point getReferencePoint()
```
    Gets the point at which the propulsion model is to be applied.
  - setReferencePoint
```
public final void setReferencePoint(Point value)
```
    Sets the point at which the propulsion model is to be applied.
  - getPropellerCount
```
public final int getPropellerCount()
```
    Gets the number of propellers for the propulsion model.
    The default value is 1.
  - setPropellerCount
```
public final void setPropellerCount(int value)
```
    Sets the number of propellers for the propulsion model.
    The default value is 1.
  - getPropellerRadius
```
public final ValueDefinition<Double> getPropellerRadius()
```
    Gets the radius of the propellers.
    The default value is 1.0.
  - setPropellerRadius
```
public final void setPropellerRadius(ValueDefinition<Double> value)
```
    Sets the radius of the propellers.
    The default value is 1.0.
  - getFuelFlowRateLimits
```
@Nonnull
public final Bounds getFuelFlowRateLimits()
```
    Gets the fuel flow rate limits, typically defined at nominal sea level atmospheric density.
  - setFuelFlowRateLimits
```
public final void setFuelFlowRateLimits(@Nonnull
                                        Bounds value)
```
    Sets the fuel flow rate limits, typically defined at nominal sea level atmospheric density.
  - getPowerAvailableLimits
```
@Nonnull
public final Bounds getPowerAvailableLimits()
```
    Gets the available power limits, typically defined at nominal sea level atmospheric density.
  - setPowerAvailableLimits
```
public final void setPowerAvailableLimits(@Nonnull
                                          Bounds value)
```
    Sets the available power limits, typically defined at nominal sea level atmospheric density.
  - getPowerDropOffParameter
```
public final ValueDefinition<Double> getPowerDropOffParameter()
```
    Gets the constant used in the computation of the Gagg-Farrar power drop off factor.
    The default value is 0.117.
  - setPowerDropOffParameter
```
public final void setPowerDropOffParameter(ValueDefinition<Double> value)
```
    Sets the constant used in the computation of the Gagg-Farrar power drop off factor.
    The default value is 0.117.
  - getDensityRatio
```
public final ScalarDependentOnServiceProvider getDensityRatio()
```
    Gets the scalar defining the ratio of the local atmospheric density to a reference density (usually standard mean sea level density).
  - setDensityRatio
```
public final void setDensityRatio(ScalarDependentOnServiceProvider value)
```
    Sets the scalar defining the ratio of the local atmospheric density to a reference density (usually standard mean sea level density).
  - getDensity
```
public final ScalarDependentOnServiceProvider getDensity()
```
    Gets the scalar defining the local atmospheric density.
  - setDensity
```
public final void setDensity(ScalarDependentOnServiceProvider value)
```
    Sets the scalar defining the local atmospheric density.
  - getRelativeVelocity
```
public final VectorDependentOnServiceProvider getRelativeVelocity()
```
    Gets the velocity vector relative to the atmosphere.
  - setRelativeVelocity
```
public final void setRelativeVelocity(VectorDependentOnServiceProvider value)
```
    Sets the velocity vector relative to the atmosphere.
  - getThrustRequired
```
public final Scalar getThrustRequired()
```
    Gets the required thrust.
  - setThrustRequired
```
public final void setThrustRequired(Scalar value)
```
    Sets the required thrust.
  - getPowerRequired
```
@Nonnull
public final Scalar getPowerRequired()
```
    Gets the power required.
  - getThrottleSetting
```
@Nonnull
public final Scalar getThrottleSetting()
```
    Gets the throttle setting.
  - getFuelFlowRate
```
@Nonnull
public final Scalar getFuelFlowRate()
```
    Gets the fuel flow rate.

Class SimpleForwardFlightPropellerPropulsion

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

SimpleForwardFlightPropellerPropulsion

Method Detail

clone

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

getReferencePoint

setReferencePoint

getPropellerCount

setPropellerCount

getPropellerRadius

setPropellerRadius

getFuelFlowRateLimits

setFuelFlowRateLimits

getPowerAvailableLimits

setPowerAvailableLimits

getPowerDropOffParameter

setPowerDropOffParameter

getDensityRatio

setDensityRatio

getDensity

setDensity

getRelativeVelocity

setRelativeVelocity

getThrustRequired

setThrustRequired

getPowerRequired

getThrottleSetting

getFuelFlowRate