public class TranslationalMotionInterpolator extends DefinitionalObject
Cartesian coordinates.| Modifier | Constructor and Description |
|---|---|
|
TranslationalMotionInterpolator()
Initializes a new instance.
|
|
TranslationalMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm,
int degree,
DateMotionCollection1<Cartesian> data)
Initializes a new instance.
|
|
TranslationalMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm,
int degree,
DateMotionCollection1<Cartesian> data,
List<JulianDate> segmentBoundaryTimes)
Initializes a new instance.
|
|
TranslationalMotionInterpolator(InterpolationAlgorithmType algorithmType,
int degree,
DateMotionCollection1<Cartesian> data)
Initializes a new instance.
|
|
TranslationalMotionInterpolator(InterpolationAlgorithmType algorithmType,
int degree,
DateMotionCollection1<Cartesian> data,
List<JulianDate> segmentBoundaryTimes)
Initializes a new instance.
|
protected |
TranslationalMotionInterpolator(TranslationalMotionInterpolator existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| 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 boolean |
checkForSameDefinition(TranslationalMotionInterpolator 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. |
DateMotionCollection1<Cartesian> |
getData()
Gets the data over which to interpolate.
|
int |
getDegree()
Gets the degree of interpolation to perform.
|
MotionEvaluator1<Cartesian> |
getEvaluator()
Gets an evaluator that interpolates and extrapolates translational motion represented as
Cartesian coordinates. |
MotionEvaluator1<Cartesian> |
getEvaluator(EvaluatorGroup group)
Gets an evaluator that interpolates and extrapolates translational motion represented as
Cartesian coordinates. |
InterpolationAlgorithm |
getInterpolationAlgorithm()
Gets the interpolation algorithm used to interpolate the translational motion.
|
List<JulianDate> |
getSegmentBoundaryTimes()
Gets the boundary times between segments that the interpolator should not interpolate over.
|
void |
setData(DateMotionCollection1<Cartesian> value)
Sets the data over which to interpolate.
|
void |
setDegree(int value)
Sets the degree of interpolation to perform.
|
void |
setInterpolationAlgorithm(InterpolationAlgorithm value)
Sets the interpolation algorithm used to interpolate the translational motion.
|
void |
setSegmentBoundaryTimes(List<JulianDate> value)
Sets the boundary times between segments that the interpolator should not interpolate over.
|
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic TranslationalMotionInterpolator()
public TranslationalMotionInterpolator(@Nonnull InterpolationAlgorithmType algorithmType, int degree, DateMotionCollection1<Cartesian> data)
algorithmType - The type of interpolation algorithm to use to interpolate the motion.degree - The degree of interpolation to perform.data - The data over which to interpolate.public TranslationalMotionInterpolator(@Nonnull InterpolationAlgorithmType algorithmType, int degree, DateMotionCollection1<Cartesian> data, List<JulianDate> segmentBoundaryTimes)
algorithmType - The type of interpolation algorithm to use to interpolate the motion.degree - The degree of interpolation to perform.data - The data over which to interpolate.segmentBoundaryTimes - The boundary times between segments that the interpolator should not interpolate over.public TranslationalMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm, int degree, DateMotionCollection1<Cartesian> data)
interpolationAlgorithm - The interpolation algorithm to use to interpolate the motion.degree - The degree of interpolation to perform.data - The data over which to interpolate.public TranslationalMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm, int degree, DateMotionCollection1<Cartesian> data, List<JulianDate> segmentBoundaryTimes)
interpolationAlgorithm - The interpolation algorithm to use to interpolate the motion.degree - The degree of interpolation to perform.data - The data over which to interpolate.segmentBoundaryTimes - The boundary times between segments that the interpolator should not interpolate over.protected TranslationalMotionInterpolator(@Nonnull TranslationalMotionInterpolator existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.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 final boolean checkForSameDefinition(DefinitionalObject 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 DefinitionalObjectother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(TranslationalMotionInterpolator 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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
TranslationalMotionInterpolator.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.computeCurrentDefinitionHashCode in class DefinitionalObjectpublic 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.public final List<JulianDate> getSegmentBoundaryTimes()
In case of data sharing the same JulianDate at a segment boundary note the following behavior:
When interpolating to a segment boundary the first datum encountered in the collection is used if there are duplicate data at the segment boundary. When interpolating from a
segment boundary, or requesting data at the segment boundary, the last node encountered in the collection is used.
public final void setSegmentBoundaryTimes(List<JulianDate> value)
In case of data sharing the same JulianDate at a segment boundary note the following behavior:
When interpolating to a segment boundary the first datum encountered in the collection is used if there are duplicate data at the segment boundary. When interpolating from a
segment boundary, or requesting data at the segment boundary, the last node encountered in the collection is used.
public final int getDegree()
public final void setDegree(int value)
public final InterpolationAlgorithm getInterpolationAlgorithm()
public final void setInterpolationAlgorithm(InterpolationAlgorithm value)
public final DateMotionCollection1<Cartesian> getData()
public final void setData(DateMotionCollection1<Cartesian> value)
@Nonnull public final MotionEvaluator1<Cartesian> getEvaluator()
Cartesian coordinates.@Nonnull public final MotionEvaluator1<Cartesian> getEvaluator(@Nonnull EvaluatorGroup group)
Cartesian coordinates.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.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when Data (get / set) or InterpolationAlgorithm (get / set) is null,
or when InterpolationAlgorithm (get / set) does not have derivative information up to the required order.IllegalStateException - Thrown when the InterpolationAlgorithm (get / set) requires more derivatives than were provided.