agi.foundation.segmentpropagation

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

Class BasicLaunchSegmentResults

java.lang.Object

agi.foundation.segmentpropagation.SegmentResults

agi.foundation.segmentpropagation.BasicLaunchSegmentResults

All Implemented Interfaces:

ICloneWithContext, IThreadAware

public class BasicLaunchSegmentResults
extends SegmentResults

The basic launch segment results. In addition to the results offered in the base type of SegmentResults, this derived type offers several boolean properties used to flag warnings in the propagator which are not fatal to propagation but should be checked.

Constructor Summary

Constructors

Constructor and Description
BasicLaunchSegmentResults(BasicLaunchSegmentResults existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
BasicLaunchSegmentResults(SegmentPropagator propagator) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
boolean	getFinalFlightPathAngleMismatch() Gets a value indicating whether the propagator was unable to meet the specified final flight path angle and there is a discontinuity in the flight path angle at burnout.
boolean	getUnableToMeetConditionsWithSetInitialAcceleration() Gets a value indicating whether the propagator was unable to meet the specified launch conditions and the propagator ignored the initial acceleration specified.
boolean	getVelocityDiscontinuityAtBurnout() Gets a value indicating whether the propagator was unable to meet the specified launch conditions and there is a discontinuity in the velocity at burnout.
void	setFinalFlightPathAngleMismatch(boolean value) Sets a value indicating whether the propagator was unable to meet the specified final flight path angle and there is a discontinuity in the flight path angle at burnout.
void	setUnableToMeetConditionsWithSetInitialAcceleration(boolean value) Sets a value indicating whether the propagator was unable to meet the specified launch conditions and the propagator ignored the initial acceleration specified.
void	setVelocityDiscontinuityAtBurnout(boolean value) Sets a value indicating whether the propagator was unable to meet the specified launch conditions and there is a discontinuity in the velocity at burnout.

Methods inherited from class agi.foundation.segmentpropagation.SegmentResults

addEphemerisPoint, cropEphemerisForOverallTrajectory, getAdapter, getAdapters, getAdditionalSegmentResults, getCanceled, getConfiguration, getDateMotionCollection, getDateMotionCollectionOfOverallTrajectory, getDateMotionCollectionOfOverallTrajectory, getElementDefinedIn, 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

BasicLaunchSegmentResults

public BasicLaunchSegmentResults(@Nonnull
                                 SegmentPropagator propagator)

Initializes a new instance. This constructor will add all of state element adapters included with the propagator.

Parameters:

propagator - The SegmentPropagator that is generating the results.

BasicLaunchSegmentResults

public BasicLaunchSegmentResults(@Nonnull
                                 BasicLaunchSegmentResults 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 SegmentResults

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getFinalFlightPathAngleMismatch

public final boolean getFinalFlightPathAngleMismatch()

Gets a value indicating whether the propagator was unable to meet the specified final flight path angle and there is a discontinuity in the flight path angle at burnout.

setFinalFlightPathAngleMismatch

public final void setFinalFlightPathAngleMismatch(boolean value)

Sets a value indicating whether the propagator was unable to meet the specified final flight path angle and there is a discontinuity in the flight path angle at burnout.

getUnableToMeetConditionsWithSetInitialAcceleration

public final boolean getUnableToMeetConditionsWithSetInitialAcceleration()

Gets a value indicating whether the propagator was unable to meet the specified launch conditions and the propagator ignored the initial acceleration specified.

setUnableToMeetConditionsWithSetInitialAcceleration

public final void setUnableToMeetConditionsWithSetInitialAcceleration(boolean value)

Sets a value indicating whether the propagator was unable to meet the specified launch conditions and the propagator ignored the initial acceleration specified.

getVelocityDiscontinuityAtBurnout

public final boolean getVelocityDiscontinuityAtBurnout()

Gets a value indicating whether the propagator was unable to meet the specified launch conditions and there is a discontinuity in the velocity at burnout.

setVelocityDiscontinuityAtBurnout

public final void setVelocityDiscontinuityAtBurnout(boolean value)

Sets a value indicating whether the propagator was unable to meet the specified launch conditions and there is a discontinuity in the velocity at burnout.