agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r3.jar)

Class PropagateSegmentResults

java.lang.Object

agi.foundation.segmentpropagation.SegmentResults

agi.foundation.segmentpropagation.SegmentListResults

agi.foundation.segmentpropagation.PropagateSegmentResults

All Implemented Interfaces:

ICloneWithContext, IThreadAware

Direct Known Subclasses:

FiniteManeuverSegmentResults, FollowSegmentResults

public class PropagateSegmentResults
extends SegmentListResults

A PropagateSegment can optionally propagate multiple segments with an auto-sequence with stopping conditions. When auto-sequences are run (possibly multiple times), there will be a pattern where the PropagateSegments propagator propagates, then the SegmentPropagator for the stopping conditions auto sequence will run, then the original propagator if the stopping condition is configured to be tripped multiple times. The overall SegmentResults (get) returned will be the PropagateSegmentResults which is a SegmentList of all of the segments propagated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropagateSegmentResults(PropagateSegmentResults existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	PropagateSegmentResults(SegmentPropagator propagator) Initializes a new instance.
	PropagateSegmentResults(SegmentPropagator propagator, ITimeBasedState initialState) Initializes a new instance.
	PropagateSegmentResults(SegmentPropagator propagator, PropagateSegmentResults results) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	addStoppingConditionBackwardsAdapters(SegmentDefinition segment, List<StateElementAdapter> backwardsAdapters) It is not known ahead of time which of the auto-segments associated with a StoppingCondition will be run.
List<StateElementAdapter>	backwardsAdaptersForStoppingConditionSegment(StoppingCondition condition) Gets the List of backwards adapters associated with the condition.
Object	clone(CopyContext context) Clones this object using the specified context.
List<StoppingCondition>	getConditionsThatStoppedPropagation() Gets all of the StoppingConditions that stopped propagation in the order that they occurred.
StoppingCondition	getConditionStoppedOn() Gets the final StoppingCondition that stopped propagation.
StoppablePropagatorResults	getStoppablePropagatorResults() Gets the results of the wrapped StoppablePropagator.
boolean	getStoppedOnMaximumDuration() Gets a value indicating whether the propagation stopped due to the MaximumDuration (get / set) being exceeded.
double	getValueOfStoppingCondition() Gets the value of the final StoppingCondition that stopped propagation.
void	regenerateEphemerisForOverallTrajectory() Regenerates the ephemeris for this.
void	setConditionStoppedOn(StoppingCondition value) Sets the final StoppingCondition that stopped propagation.
void	setStoppablePropagatorResults(StoppablePropagatorResults value) Sets the results of the wrapped StoppablePropagator.
void	setStoppedOnMaximumDuration(boolean value) Sets a value indicating whether the propagation stopped due to the MaximumDuration (get / set) being exceeded.

Methods inherited from class agi.foundation.segmentpropagation.SegmentListResults

cropEphemerisForOverallTrajectory, generateOverallTrajectory, getDateMotionCollectionOfOverallTrajectory, getDateMotionCollectionOfOverallTrajectory, getElementDefinedIn, getFinalNestedSegmentResult, getFinalSegmentResult, getSegmentBoundaryTimes, getSegmentResults, isSegmentContainedInThisList, propagateToAssumingTimeBasedStates

Methods inherited from class agi.foundation.segmentpropagation.SegmentResults

addEphemerisPoint, getAdapter, getAdapters, getAdditionalSegmentResults, getCanceled, getConfiguration, getDateMotionCollection, getEntireComputedEphemeris, getEphemerisForOverallTrajectory, getFinalPropagatedState, getFirstPropagatedState, getIdentifiers, getInitialState, getIsThreadSafe, getMotionCollection, getMotionCollection, getOverrideSegmentListEphemeris, getParentResults, getPropagationDirection, getPropagator, getResultsOfSegment, getSegmentCompletelyOverriddenByOverlappingSegment, getSegmentIdentifier, getSegmentOverrideStartsIn, getStateForNextSegment, getStateForNextSegmentBehavior, getStopAllPropagation, getStopPropagationForCurrentSegmentList, getTimeIntervalOfEntireComputedEphemeris, getTimeIntervalOfEphemerisForOverallTrajectory, indexOfStateWithDateFromEntireComputedEphemeris, setCanceled, setConfiguration, setElementDefinedIn, setInitialState, setOverrideSegmentListEphemeris, setParentResults, setSegmentCompletelyOverriddenByOverlappingSegment, setSegmentOverrideStartsIn, setStopAllPropagation, setStopPropagationForCurrentSegmentList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropagateSegmentResults

public PropagateSegmentResults(@Nonnull
                               SegmentPropagator propagator,
                               PropagateSegmentResults results)

Initializes a new instance.

Parameters:

propagator - The SegmentPropagator that has created these results.

results - The results in which the stoppable results, condition stopped on, stopped on maximum duration and the base results are extracted.

PropagateSegmentResults

public PropagateSegmentResults(@Nonnull
                               SegmentPropagator propagator)

Initializes a new instance.

Parameters:

propagator - The SegmentPropagator that has created these results.

PropagateSegmentResults

public PropagateSegmentResults(@Nonnull
                               SegmentPropagator propagator,
                               ITimeBasedState initialState)

Initializes a new instance.

Parameters:

propagator - The SegmentPropagator that has created these results.

initialState - The initial state that the propagator was propagated from.

PropagateSegmentResults

protected PropagateSegmentResults(@Nonnull
                                  PropagateSegmentResults 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

Overrides:

clone in class SegmentListResults

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getConditionStoppedOn

public final StoppingCondition getConditionStoppedOn()

Gets the final StoppingCondition that stopped propagation.

setConditionStoppedOn

public final void setConditionStoppedOn(StoppingCondition value)

Sets the final StoppingCondition that stopped propagation.

getValueOfStoppingCondition

public final double getValueOfStoppingCondition()

Gets the value of the final StoppingCondition that stopped propagation.

getConditionsThatStoppedPropagation

public final List<StoppingCondition> getConditionsThatStoppedPropagation()

Gets all of the StoppingConditions that stopped propagation in the order that they occurred. This list will have more than 1 StoppingCondition if a StoppingCondition that was satisfied was instructed to propagate its auto-segment multiple times. See PropagateSegment.setStoppingConditionAutoSegment(agi.foundation.stoppingconditions.StoppingCondition, agi.foundation.segmentpropagation.SegmentDefinition, int) for more details. If you did not configure any auto-sequences for your StoppingConditions then there will be a single StoppingCondition in this list.

addStoppingConditionBackwardsAdapters

public final void addStoppingConditionBackwardsAdapters(SegmentDefinition segment,
                                                        List<StateElementAdapter> backwardsAdapters)

It is not known ahead of time which of the auto-segments associated with a StoppingCondition will be run. So the adapters that go from the auto-segment back to the native defined-ins of the parent NumericalPropagatorSegment must be available for use. This method allows you to add those adapters to these results.

Parameters:

segment - The SegmentDefinition associated with the backwardsAdapters.

backwardsAdapters - The adapters that can adapt states from the SegmentPropagator that was the auto-segment associated with the segment.

backwardsAdaptersForStoppingConditionSegment

public final List<StateElementAdapter> backwardsAdaptersForStoppingConditionSegment(StoppingCondition condition)

Gets the List of backwards adapters associated with the condition. These adapters will allow you to adapt the SegmentResults (get) of the auto-segment associated with the condition back to the defined-ins of the initial propagation of the NumericalPropagatorSegment that made these results.

Parameters:

condition - The StoppingCondition whose backwards adapters will be retrieved.

Returns:

The adapters that can adapt states from the SegmentPropagator that was the auto-segment associated with the condition.

getStoppedOnMaximumDuration

public final boolean getStoppedOnMaximumDuration()

Gets a value indicating whether the propagation stopped due to the MaximumDuration (get / set) being exceeded.

setStoppedOnMaximumDuration

public final void setStoppedOnMaximumDuration(boolean value)

Sets a value indicating whether the propagation stopped due to the MaximumDuration (get / set) being exceeded.

getStoppablePropagatorResults

public final StoppablePropagatorResults getStoppablePropagatorResults()

Gets the results of the wrapped StoppablePropagator.

setStoppablePropagatorResults

public final void setStoppablePropagatorResults(StoppablePropagatorResults value)

Sets the results of the wrapped StoppablePropagator.

regenerateEphemerisForOverallTrajectory

public void regenerateEphemerisForOverallTrajectory()

Regenerates the ephemeris for this. The EphemerisForOverallTrajectory (get) will get rebuilt for this and all child segments. The states in this SegmentList will be adapted to the final stored segment in this.

Overrides:

regenerateEphemerisForOverallTrajectory in class SegmentListResults