agi.foundation.segmentpropagation

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

Class SeedFiniteManeuverOperator

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.segmentpropagation.TargetedSegmentListOperator

agi.foundation.segmentpropagation.SeedFiniteManeuverOperator

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SeedFiniteManeuverOperator
extends TargetedSegmentListOperator

An operator that will replace an ImpulsiveManeuverSegment with a similarly configured FiniteManeuverSegment in a TargetedSegmentList. Due to the fact that a single DurationStoppingCondition is set with the time needed to perform the required delta-v, only a single maneuver is supported.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SeedFiniteManeuverOperator() Initialize a new instance.
protected	SeedFiniteManeuverOperator(SeedFiniteManeuverOperator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	SeedFiniteManeuverOperator(SwitchableSegment switchableManeuverSegment, String propagationElement) Initializes a new instance.
	SeedFiniteManeuverOperator(SwitchableSegment switchableManeuverSegment, String propagationElement, Scalar fuelFlowScalar, DurationStoppingCondition stoppingCondition) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(SeedFiniteManeuverOperator other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(TargetedSegmentListOperator 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.
Scalar	getFuelFlowRateScalar() Gets the scalar representing the fuel flow rate.
TargetedSegmentListOperatorEvaluator	getOperatorEvaluator(EvaluatorGroup group) Creates and returns the fully configured TargetedSegmentListOperatorEvaluator for use in a TargetedSegmentLists propagator.
String	getPropagationElementIdentification() Gets the name of the propagated point element that is performing the maneuver.
DurationStoppingCondition	getStoppingConditionToUpdate() Gets the DurationStoppingCondition in the SwitchableManeuverSegment (get / set) that should be updated.
SwitchableSegment	getSwitchableManeuverSegment() Gets the SwitchableSegment whose PrimarySegment (get / set) is a FiniteManeuverSegment and whose AlternateSegment (get / set) is an ImpulsiveManeuverSegment.
void	setFuelFlowRateScalar(Scalar value) Sets the scalar representing the fuel flow rate.
void	setPropagationElementIdentification(String value) Sets the name of the propagated point element that is performing the maneuver.
void	setStoppingConditionToUpdate(DurationStoppingCondition value) Sets the DurationStoppingCondition in the SwitchableManeuverSegment (get / set) that should be updated.
void	setSwitchableManeuverSegment(SwitchableSegment value) Sets the SwitchableSegment whose PrimarySegment (get / set) is a FiniteManeuverSegment and whose AlternateSegment (get / set) is an ImpulsiveManeuverSegment.

Methods inherited from class agi.foundation.segmentpropagation.TargetedSegmentListOperator

checkForSameDefinition, getName, setName

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

SeedFiniteManeuverOperator

public SeedFiniteManeuverOperator()

Initialize a new instance. FuelFlowRateScalar (get / set), SwitchableManeuverSegment (get / set), PropagationElementIdentification (get / set), and StoppingConditionToUpdate (get / set) will need to be set before SeedFiniteManeuverOperator.getOperatorEvaluator(EvaluatorGroup) can be called.

SeedFiniteManeuverOperator

public SeedFiniteManeuverOperator(SwitchableSegment switchableManeuverSegment,
                                  String propagationElement)

Initializes a new instance. FuelFlowRateScalar (get / set), SwitchableManeuverSegment (get / set), PropagationElementIdentification (get / set), and StoppingConditionToUpdate (get / set) will need to be set before SeedFiniteManeuverOperator.getOperatorEvaluator(EvaluatorGroup) can be called.

Parameters:

switchableManeuverSegment - The SwitchableSegment that contains both maneuver segments.

propagationElement - The name of the propagation element that is performing the maneuver.

SeedFiniteManeuverOperator

public SeedFiniteManeuverOperator(SwitchableSegment switchableManeuverSegment,
                                  String propagationElement,
                                  Scalar fuelFlowScalar,
                                  DurationStoppingCondition stoppingCondition)

Initializes a new instance.

Parameters:

switchableManeuverSegment - The SwitchableSegment that contains both maneuver segments.

propagationElement - The name of the propagation element that is performing the maneuver.

fuelFlowScalar - The fuel flow Scalar to use to compute the StoppingCondition of the switchableManeuverSegment.

stoppingCondition - The particular DurationStoppingCondition whose Threshold (get / set) should be updated for the switchableManeuverSegment to burn as long as needed to accomplish the delta-v dictated by the results of the original ImpulsiveManeuverSegment.

SeedFiniteManeuverOperator

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

Specified by:

clone in class TargetedSegmentListOperator

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(TargetedSegmentListOperator other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class TargetedSegmentListOperator

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(@Nullable
                                         SeedFiniteManeuverOperator other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the SeedFiniteManeuverOperator.checkForSameDefinition(agi.foundation.segmentpropagation.TargetedSegmentListOperator) method.

Overrides:

computeCurrentDefinitionHashCode in class TargetedSegmentListOperator

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getSwitchableManeuverSegment

public final SwitchableSegment getSwitchableManeuverSegment()

Gets the SwitchableSegment whose PrimarySegment (get / set) is a FiniteManeuverSegment and whose AlternateSegment (get / set) is an ImpulsiveManeuverSegment.

setSwitchableManeuverSegment

public final void setSwitchableManeuverSegment(SwitchableSegment value)

Sets the SwitchableSegment whose PrimarySegment (get / set) is a FiniteManeuverSegment and whose AlternateSegment (get / set) is an ImpulsiveManeuverSegment.

getStoppingConditionToUpdate

public final DurationStoppingCondition getStoppingConditionToUpdate()

Gets the DurationStoppingCondition in the SwitchableManeuverSegment (get / set) that should be updated. This condition must be one of the conditions on the SwitchableManeuverSegment (get / set).

setStoppingConditionToUpdate

public final void setStoppingConditionToUpdate(DurationStoppingCondition value)

Sets the DurationStoppingCondition in the SwitchableManeuverSegment (get / set) that should be updated. This condition must be one of the conditions on the SwitchableManeuverSegment (get / set).

getPropagationElementIdentification

public final String getPropagationElementIdentification()

Gets the name of the propagated point element that is performing the maneuver.

setPropagationElementIdentification

public final void setPropagationElementIdentification(String value)

Sets the name of the propagated point element that is performing the maneuver.

getFuelFlowRateScalar

public final Scalar getFuelFlowRateScalar()

Gets the scalar representing the fuel flow rate. Note that this will be evaluated once at the time of the ImpulsiveManeuverSegment to estimate the overall time needed to achieve the delta-v of the impulsive maneuver.

setFuelFlowRateScalar

public final void setFuelFlowRateScalar(Scalar value)

Sets the scalar representing the fuel flow rate. Note that this will be evaluated once at the time of the ImpulsiveManeuverSegment to estimate the overall time needed to achieve the delta-v of the impulsive maneuver.

getOperatorEvaluator

public TargetedSegmentListOperatorEvaluator getOperatorEvaluator(EvaluatorGroup group)

Creates and returns the fully configured TargetedSegmentListOperatorEvaluator for use in a TargetedSegmentLists propagator.

Specified by:

getOperatorEvaluator in class TargetedSegmentListOperator

Parameters:

group - The EvaluatorGroup to use when creating evaluators.

Returns:

The fully configured TargetedSegmentListOperatorEvaluator.