public class RoutePropagator extends DefinitionalObject
PropagatedRoute.
This can be used to either produce a route given a start time
or to produce a route given a final rendezvous time.
While this type is designed to be used for either forward or backward scheduling,
it cannot constrain both a start and a stop time for the route.
To do this, iterate the properties along the route as needed in order to satisfy the desired condition.
Using a root finder, such as BrentFindRoot, can help when doing this.
| Modifier | Constructor and Description |
|---|---|
|
RoutePropagator()
Create a new instance.
|
|
RoutePropagator(RouteConnection customDefaultConnection,
Iterable<? extends RouteSegment> procedures)
Create a new instance based on the given default connection and set of procedures.
|
protected |
RoutePropagator(RoutePropagator existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
RoutePropagator(RouteSegment... procedures)
Create a new instance based on the given set of procedures.
|
| 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(RoutePropagator 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. |
protected void |
freezeAggregatedObjects()
Called by
DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. |
CentralBody |
getCentralBody()
|
RouteConnection |
getCustomDefaultConnection()
Gets the custom connection that will be used to fill in
any missing connections in the list of route
Segments (get). |
DefaultConnectionBehavior |
getDefaultConnectionBehavior()
Gets the instance of
DefaultConnectionBehavior (get) that defines the behavior
of a generic connection segment between two RouteProcedures. |
int |
getIterationLimit()
Gets the maximum number of times to attempt to configure the surface route
before returning a route that may contain discontinuities or other problems.
|
List<RouteSegment> |
getSegments()
Gets the list of route segments including the procedures and connections.
|
PropagatedRoute |
propagateFromTime(JulianDate startTime)
Create a
PropagatedRoute by configuring the segments to represent a route
which starts at the given time. |
PropagatedRoute |
propagateFromTime(JulianDate startTime,
ITrackCalculationProgress tracker)
Create a
PropagatedRoute by configuring the segments to represent a route
which starts at the given time. |
PropagatedRoute |
propagateTowardTime(JulianDate stopTime)
Create a
PropagatedRoute by configuring the segments to represent a route
which will end at the given time (This can be useful for designing a rendezvous at a given time). |
PropagatedRoute |
propagateTowardTime(JulianDate stopTime,
ITrackCalculationProgress tracker)
Create a
PropagatedRoute by configuring the segments to represent a route
which will end at the given time (This can be useful for designing a rendezvous at a given time). |
void |
setCentralBody(CentralBody value)
|
void |
setCustomDefaultConnection(RouteConnection value)
Sets the custom connection that will be used to fill in
any missing connections in the list of route
Segments (get). |
void |
setIterationLimit(int value)
Sets the maximum number of times to attempt to configure the surface route
before returning a route that may contain discontinuities or other problems.
|
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic RoutePropagator()
public RoutePropagator(@Nonnull RouteSegment... procedures)
DefaultConnectionBehavior (get) will create connections
in between RouteProcedures.procedures - A set of procedures that define the route.public RoutePropagator(@Nullable RouteConnection customDefaultConnection, @Nonnull Iterable<? extends RouteSegment> procedures)
customDefaultConnection - The connection to use to connect the procedures together.procedures - A list of procedures that define the route.protected RoutePropagator(@Nonnull RoutePropagator 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(RoutePropagator 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()
RoutePropagator.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.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 DefinitionalObjectpublic final List<RouteSegment> getSegments()
RouteProcedures exist in the list without a RouteConnection
between them, the propagator will first see if there is a CustomDefaultConnection (get / set)
available and if not it will add a connection based on the DefaultConnectionBehavior (get) settings.
Note that two consecutive RouteConnection objects in the list will cause an error.public final CentralBody getCentralBody()
public final void setCentralBody(CentralBody value)
@Nonnull public final DefaultConnectionBehavior getDefaultConnectionBehavior()
DefaultConnectionBehavior (get) that defines the behavior
of a generic connection segment between two RouteProcedures.
If CustomDefaultConnection (get / set) is not null, it will override the default connection behavior.@Nullable public final RouteConnection getCustomDefaultConnection()
public final void setCustomDefaultConnection(@Nullable RouteConnection value)
public final int getIterationLimit()
An invalid state can occur when three consecutive procedures are codependent on each other in such a way that the configuration cannot determine the connections without iterating. In practice, this is rare.
public final void setIterationLimit(int value)
An invalid state can occur when three consecutive procedures are codependent on each other in such a way that the configuration cannot determine the connections without iterating. In practice, this is rare.
@Nonnull public final PropagatedRoute propagateFromTime(@Nonnull JulianDate startTime)
Create a PropagatedRoute by configuring the segments to represent a route
which starts at the given time. Note that the resulting PropagatedRoute instance
may contain errors if configuration could not be completed successfully.
The system will attempt to create a feasible route, even if there is an error. Make sure to check
HasConfigurationErrors (get) to see if there are
any errors and determine whether the errors indicate unexpected discontinuities.
Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the
properties of either the RoutePropagator or the Segments (get) on the propagator.
startTime - The time at which to start the route.PropagatedRoute that provides error feedback and can
produce the time dynamic geometry representing the route.@Nonnull public final PropagatedRoute propagateFromTime(@Nonnull JulianDate startTime, ITrackCalculationProgress tracker)
Create a PropagatedRoute by configuring the segments to represent a route
which starts at the given time. Note that the resulting PropagatedRoute instance
may contain errors if configuration could not be completed successfully.
The system will attempt to create a feasible route, even if there is an error. Make sure to check
HasConfigurationErrors (get) to see if there are
any errors and determine whether the errors indicate unexpected discontinuities.
Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the
properties of either the RoutePropagator or the Segments (get) on the propagator.
startTime - The time at which to start the route.tracker - A progress tracker that can give feedback on the current progress of the configuration.
The tracker may not progress uniformly if some segments require much more configuration
than others due to the geometry present between segments.PropagatedRoute that provides error feedback and can
produce the time dynamic geometry representing the route.@Nonnull public final PropagatedRoute propagateTowardTime(@Nonnull JulianDate stopTime)
Create a PropagatedRoute by configuring the segments to represent a route
which will end at the given time (This can be useful for designing a rendezvous at a given time).
Note that the resulting PropagatedRoute instance
may contain errors if configuration could not be completed successfully.
The system will attempt to create a feasible route, even if there is an error. Make sure to check
HasConfigurationErrors (get) to see if there are
any errors and determine whether the errors indicate unexpected discontinuities.
Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the
properties of either the RoutePropagator or the Segments (get) on the propagator.
stopTime - The time at which the route will end. This can also be thought of as a rendezvous time.PropagatedRoute that provides error feedback and can
produce the time dynamic geometry representing the route.@Nonnull public final PropagatedRoute propagateTowardTime(@Nonnull JulianDate stopTime, ITrackCalculationProgress tracker)
Create a PropagatedRoute by configuring the segments to represent a route
which will end at the given time (This can be useful for designing a rendezvous at a given time).
Note that the resulting PropagatedRoute instance
may contain errors if configuration could not be completed successfully.
The system will attempt to create a feasible route, even if there is an error. Make sure to check
HasConfigurationErrors (get) to see if there are
any errors and determine whether the errors indicate unexpected discontinuities.
Note that this method is safe to call from multiple threads so long as none of the threads modifies any of the
properties of either the RoutePropagator or the Segments (get) on the propagator.
stopTime - The time at which the route will end. This can also be thought of as a rendezvous time.tracker - A progress tracker that can give feedback on the current progress of the configuration.
The tracker may not progress uniformly if some segments require much more configuration
than others due to the geometry present between segments.PropagatedRoute that provides error feedback and can
produce the time dynamic geometry representing the route.