public final class AircraftMotionIntegrationPoint extends Point
| Constructor and Description |
|---|
AircraftMotionIntegrationPoint()
Initializes a new instance.
|
AircraftMotionIntegrationPoint(CentralBody centralBody)
Initializes a new instance with the given ellipsoid and frame of integration.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(Point 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.
|
static void |
configureIndicesOnEvaluator(EvaluatorGroup group,
AircraftMotionIntegrationPoint point,
Motion1<int[]> stateInputIndices)
This is called by
PropagationStateElement instances using PointPropagationParameter so that
the element can update the indices used to identify the individual values corresponding to this point in the state
during evaluation. |
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
protected void |
freezeAggregatedObjects()
Called by
DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. |
CentralBody |
getCentralBody()
|
PointEvaluator |
getEvaluator(EvaluatorGroup group)
|
ReferenceFrame |
getIntegrationFrame()
Gets the
ReferenceFrame used to define the state during integration. |
PropagationStateParameter |
getStateParameter()
Gets a parameter which represents the state during propagation.
|
void |
setCentralBody(CentralBody value)
|
void |
setStateParameter(PropagationStateParameter value)
Sets a parameter which represents the state during propagation.
|
checkForSameDefinition, createVectorAcceleration, createVectorDerivative, createVectorVelocity, getEvaluator, getRoot, getScalarElement, getScalarElement, getServiceareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic AircraftMotionIntegrationPoint()
public AircraftMotionIntegrationPoint(CentralBody centralBody)
centralBody - The ellipsoid used to define the state during integration.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(Point 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 Pointother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
AircraftMotionIntegrationPoint.checkForSameDefinition(agi.foundation.geometry.Point) method.computeCurrentDefinitionHashCode in class Pointpublic void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.protected void freezeAggregatedObjects()
DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
Derived classes which contain additional aggregated objects MUST override this method, call the base
implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be
frozen in this method are frequently created in this object's constructor and are not settable via
properties.freezeAggregatedObjects in class DefinitionalObject@Nonnull public final ReferenceFrame getIntegrationFrame()
ReferenceFrame used to define the state during integration.public final PropagationStateParameter getStateParameter()
NumericalPropagator
inside their implementation in order to produce their values. In such cases, it may
be necessary to distinguish between the state of the exterior propagator and the
state of the interior propagator. In these cases, it is up to the user to ensure
that both the state and all of its elements are configured with the same parameter.
Otherwise, the state will throw an exception when creating its propagator.public final void setStateParameter(PropagationStateParameter value)
NumericalPropagator
inside their implementation in order to produce their values. In such cases, it may
be necessary to distinguish between the state of the exterior propagator and the
state of the interior propagator. In these cases, it is up to the user to ensure
that both the state and all of its elements are configured with the same parameter.
Otherwise, the state will throw an exception when creating its propagator.public final CentralBody getCentralBody()
public final void setCentralBody(CentralBody value)
public static void configureIndicesOnEvaluator(EvaluatorGroup group, AircraftMotionIntegrationPoint point, @Nonnull Motion1<int[]> stateInputIndices)
This is called by PropagationStateElement instances using PointPropagationParameter so that
the element can update the indices used to identify the individual values corresponding to this point in the state
during evaluation. In general, this should only be called from within the PropagationStateElement.getConverter(agi.foundation.EvaluatorGroup, agi.foundation.Motion1<int[]>)
method when configuring the indices provided by the NumericalPropagatorDefinition.
The EvaluatorGroup will create an evaluator based on the StateParameter (get / set) and the IntegrationFrame (get)
and cache it for future calls. This method updates the instance variables for the indices so that it will reflect
the point's elements within the state during evaluation. In general, this breaks the "Evaluator Pattern" by altering
data on an evaluator after construction. However, so long as it is done once and only once prior to any evaluation this
is deemed as following the "Evaluator Pattern" which stipulates that an evaluator should always return the same value for
a given time.
group - The evaluator group in which to create the PointEvaluator corresponding to this point.point - The instance of the PointPropagationParameter whose evaluator will be configured.stateInputIndices - The indices representing the locations of the coordinates of this point in the state during propagation.public PointEvaluator getEvaluator(EvaluatorGroup group)
Gets an evaluator that can be used to find the motion of this point in its parent reference frame
based on the state provided by evaluating the evaluator produced by the StateParameter (get / set).
Consider using the methods of GeometryTransformer instead of calling this method directly.
See Point.getEvaluator(EvaluatorGroup) for more details.
This type will usually not be used directly. It is instead used by
AircraftMotionIntegrationPoint behind the scenes. If this type is used, such as
during the implementation of a type similar to or deriving from
AircraftMotionIntegrationPoint, always call
AircraftMotionIntegrationPoint.configureIndicesOnEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.aircraftpropagation.AircraftMotionIntegrationPoint, agi.foundation.Motion1<int[]>) prior to this method.
getEvaluator in class Pointgroup - The group in which to create the evaluator and its dependents.Point based on the current state.The evaluator that computes the motion of the point.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when the property StateParameter (get / set) or IntegrationFrame (get) or CentralBody (get / set) is null.