agi.foundation.segmentpropagation

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

Class ImpulsiveManeuverInformation

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.segmentpropagation.ImpulsiveManeuverInformation

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IThreadAware

public class ImpulsiveManeuverInformation
extends DefinitionalObject
implements IThreadAware

Stores all the information needed for a maneuver to be performed by an ImpulsiveManeuverSegment.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImpulsiveManeuverInformation() Initializes a new instance.
protected	ImpulsiveManeuverInformation(ImpulsiveManeuverInformation existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	ImpulsiveManeuverInformation(String propagationElementIdentification, Cartesian deltaV) Initializes a new instance.
	ImpulsiveManeuverInformation(String propagationElementIdentification, Cartesian deltaV, Axes orientationAxes) Initializes a new instance.
	ImpulsiveManeuverInformation(String propagationElementIdentification, Cartesian deltaV, Axes orientationAxes, String fuelMassIdentification, String dryMassIdentification, Scalar exhaustVelocity, InvalidFuelStateBehavior whatToDo) Initializes a new instance.
	ImpulsiveManeuverInformation(String propagationElementIdentification, Cartesian deltaV, String fuelMassIdentification, String dryMassIdentification, Scalar exhaustVelocity, InvalidFuelStateBehavior whatToDo) Initializes a new instance.

Method Summary

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(ImpulsiveManeuverInformation 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.
String	getCostateElementIdentification() Gets or sets the identification of the optional costate vector element in the state passed into the ImpulsiveManeuverSegment.
Vector	getCostateVector() Gets the Vector that can optionally be used to construct geometry types (such as the Orientation (get / set)) that represent the CostateElementIdentification (get / set) at propagation time.
Cartesian	getDeltaV() Gets the delta-V that will get applied to the PropagationElementIdentification (get / set).
String	getDryMassIdentification() Gets the identification of the dry mass getting propagated.
Scalar	getExhaustVelocity() Gets the exhaust velocity in meters per second.
String	getFuelMassIdentification() Gets the identification of the fuel mass getting propagated.
CartesianParameter	getInnerCostateParameter() Gets a second optional parameter that can be used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).
CartesianParameter	getInnerParameter() Gets the parameter used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).
InvalidFuelStateBehavior	getInvalidFuelUseBehavior() Gets a enum specifying what should be done if there is not enough fuel for the requested DeltaV (get / set).
boolean	getIsThreadSafe() Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Axes	getOrientation() Gets the orientation of the engines that will apply the DeltaV (get / set).
String	getPropagationElementIdentification() Gets the identification of the point element in the state passed into the ImpulsiveManeuverSegment that the DeltaV (get / set) will be applied to.
Point	getPropagationPoint() Gets the Point to use when constructing geometry types (such as the Orientation (get / set) that represents the PropagationElementIdentification (get / set) at propagation time.
double	getX() Gets the X component of the DeltaV (get / set).
double	getY() Gets the Y component of the DeltaV (get / set).
double	getZ() Gets the Z component of the DeltaV (get / set).
void	setCostateElementIdentification(String value) Gets or sets the identification of the optional costate vector element in the state passed into the ImpulsiveManeuverSegment.
void	setDeltaV(Cartesian value) Sets the delta-V that will get applied to the PropagationElementIdentification (get / set).
void	setDryMassIdentification(String value) Sets the identification of the dry mass getting propagated.
void	setExhaustVelocity(Scalar value) Sets the exhaust velocity in meters per second.
void	setFuelMassIdentification(String value) Sets the identification of the fuel mass getting propagated.
void	setInnerCostateParameter(CartesianParameter value) Sets a second optional parameter that can be used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).
void	setInnerParameter(CartesianParameter value) Sets the parameter used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).
void	setInvalidFuelUseBehavior(InvalidFuelStateBehavior value) Sets a enum specifying what should be done if there is not enough fuel for the requested DeltaV (get / set).
void	setOrientation(Axes value) Sets the orientation of the engines that will apply the DeltaV (get / set).
void	setPropagationElementIdentification(String value) Sets the identification of the point element in the state passed into the ImpulsiveManeuverSegment that the DeltaV (get / set) will be applied to.
void	setX(double value) Sets the X component of the DeltaV (get / set).
void	setY(double value) Sets the Y component of the DeltaV (get / set).
void	setZ(double value) Sets the Z component of the DeltaV (get / set).

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

ImpulsiveManeuverInformation

public ImpulsiveManeuverInformation()

Initializes a new instance.

ImpulsiveManeuverInformation

public ImpulsiveManeuverInformation(String propagationElementIdentification,
                                    @Nonnull
                                    Cartesian deltaV,
                                    Axes orientationAxes,
                                    String fuelMassIdentification,
                                    String dryMassIdentification,
                                    Scalar exhaustVelocity,
                                    @Nonnull
                                    InvalidFuelStateBehavior whatToDo)

Initializes a new instance.

Parameters:

propagationElementIdentification - The name of the point element that will get the delta-V applied to it.

deltaV - The change in velocity that propagationElementIdentification will experience when propagated.

orientationAxes - The Axes defining the orientation of the engine being fired. If your Axes depends on the point being propagated, use the PropagationPoint (get) property in your axes.

fuelMassIdentification - The identification of the fuel mass element getting propagated.

dryMassIdentification - The identification of the dry mass element getting propagated.

exhaustVelocity - The exhaust velocity of the engine.

whatToDo - Specify what will be done if there is not enough fuel for the requested delta-V.

ImpulsiveManeuverInformation

public ImpulsiveManeuverInformation(String propagationElementIdentification,
                                    @Nonnull
                                    Cartesian deltaV,
                                    String fuelMassIdentification,
                                    String dryMassIdentification,
                                    Scalar exhaustVelocity,
                                    @Nonnull
                                    InvalidFuelStateBehavior whatToDo)

Initializes a new instance.

Parameters:

propagationElementIdentification - The point element that will get the delta-V applied to it.

deltaV - The change in velocity that propagationElementIdentification will experience when propagated.

fuelMassIdentification - The identification of the fuel mass element getting propagated.

dryMassIdentification - The identification of the dry mass element getting propagated.

exhaustVelocity - The exhaust velocity of the engine.

whatToDo - Specify what will be done if there is not enough fuel for the requested delta-V.

ImpulsiveManeuverInformation

public ImpulsiveManeuverInformation(String propagationElementIdentification,
                                    @Nonnull
                                    Cartesian deltaV,
                                    Axes orientationAxes)

Initializes a new instance. Unless the FuelMassIdentification (get / set), DryMassIdentification (get / set) and ExhaustVelocity (get / set) properties are configured there will be no attempt to keep track of fuel usage at propagation time.

Parameters:

propagationElementIdentification - The element that will get the delta-V applied to it.

orientationAxes - The Axes defining the orientation of the engine being fired. If your Axes depends on the point being propagated, use the PropagationPoint (get) property in your axes.

deltaV - The change in velocity that propagationElementIdentification will experience when propagated.

ImpulsiveManeuverInformation

public ImpulsiveManeuverInformation(String propagationElementIdentification,
                                    @Nonnull
                                    Cartesian deltaV)

Initializes a new instance. Unless the FuelMassIdentification (get / set), DryMassIdentification (get / set) and ExhaustVelocity (get / set) properties are configured there will be no attempt to keep track of fuel usage at propagation time.

Parameters:

propagationElementIdentification - The element that will get the delta-V applied to it.

deltaV - The change in velocity that propagationElementIdentification will experience when propagated.

ImpulsiveManeuverInformation

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

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(DefinitionalObject 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 DefinitionalObject

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(ImpulsiveManeuverInformation 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 ImpulsiveManeuverInformation.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

getIsThreadSafe

public final boolean getIsThreadSafe()

Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

If this property is true, all methods and properties are guaranteed to be thread safe. Conceptually, an object that returns true for this method acts as if there is a lock protecting each method and property such that only one thread at a time can be inside any method or property in the class. In reality, such locks are generally not used and are in fact discouraged. However, the user must not experience any exceptions or inconsistent behavior that would not be experienced if such locks were used.

If this property is false, the behavior when using this class from multiple threads simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the object for each thread.

Specified by:

getIsThreadSafe in interface IThreadAware

getPropagationPoint

public final Point getPropagationPoint()

Gets the Point to use when constructing geometry types (such as the Orientation (get / set) that represents the PropagationElementIdentification (get / set) at propagation time.

getCostateVector

public final Vector getCostateVector()

Gets the Vector that can optionally be used to construct geometry types (such as the Orientation (get / set)) that represent the CostateElementIdentification (get / set) at propagation time.

getOrientation

public final Axes getOrientation()

Gets the orientation of the engines that will apply the DeltaV (get / set). If your axes depends on the point being propagated, such as an AxesVelocityOrbitNormal, use the PropagationPoint (get) in defining that Axes. If your axes depend on an optionally defined costate vector, use the CostateVector (get) in defining that Axes.

setOrientation

public final void setOrientation(Axes value)

Sets the orientation of the engines that will apply the DeltaV (get / set). If your axes depends on the point being propagated, such as an AxesVelocityOrbitNormal, use the PropagationPoint (get) in defining that Axes. If your axes depend on an optionally defined costate vector, use the CostateVector (get) in defining that Axes.

getInnerParameter

public final CartesianParameter getInnerParameter()

Gets the parameter used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).

setInnerParameter

public final void setInnerParameter(CartesianParameter value)

Sets the parameter used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).

getInnerCostateParameter

public final CartesianParameter getInnerCostateParameter()

Gets a second optional parameter that can be used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).

setInnerCostateParameter

public final void setInnerCostateParameter(CartesianParameter value)

Sets a second optional parameter that can be used to evaluate the Orientation (get / set) and ExhaustVelocity (get / set).

getPropagationElementIdentification

public final String getPropagationElementIdentification()

Gets the identification of the point element in the state passed into the ImpulsiveManeuverSegment that the DeltaV (get / set) will be applied to. For a given ImpulsiveManeuverSegment, there may not be two maneuvers operating on the same propagation element.

setPropagationElementIdentification

public final void setPropagationElementIdentification(String value)

Sets the identification of the point element in the state passed into the ImpulsiveManeuverSegment that the DeltaV (get / set) will be applied to. For a given ImpulsiveManeuverSegment, there may not be two maneuvers operating on the same propagation element.

getCostateElementIdentification

@Nullable
public final String getCostateElementIdentification()

Gets or sets the identification of the optional costate vector element in the state passed into the ImpulsiveManeuverSegment. This should be the identification of a PropagationVector or a similarly configured custom type. The costate could represent a primer vector as introduced by D. F. Lawden in "Optimal Trajectories for Space Navigation", 1964.

If this is empty or null, the CostateVector (get) and InnerCostateParameter (get / set) will not be available to the propagator generated by the ImpulsiveManeuverSegment.

setCostateElementIdentification

public final void setCostateElementIdentification(@Nullable
                                                  String value)

Gets or sets the identification of the optional costate vector element in the state passed into the ImpulsiveManeuverSegment. This should be the identification of a PropagationVector or a similarly configured custom type. The costate could represent a primer vector as introduced by D. F. Lawden in "Optimal Trajectories for Space Navigation", 1964.

If this is empty or null, the CostateVector (get) and InnerCostateParameter (get / set) will not be available to the propagator generated by the ImpulsiveManeuverSegment.

getDeltaV

@Nonnull
public final Cartesian getDeltaV()

Gets the delta-V that will get applied to the PropagationElementIdentification (get / set).

setDeltaV

public final void setDeltaV(@Nonnull
                            Cartesian value)

Sets the delta-V that will get applied to the PropagationElementIdentification (get / set).

getX

public final double getX()

Gets the X component of the DeltaV (get / set).

setX

public final void setX(double value)

Sets the X component of the DeltaV (get / set).

getY

public final double getY()

Gets the Y component of the DeltaV (get / set).

setY

public final void setY(double value)

Sets the Y component of the DeltaV (get / set).

getZ

public final double getZ()

Gets the Z component of the DeltaV (get / set).

setZ

public final void setZ(double value)

Sets the Z component of the DeltaV (get / set).

getFuelMassIdentification

public final String getFuelMassIdentification()

Gets the identification of the fuel mass getting propagated.

setFuelMassIdentification

public final void setFuelMassIdentification(String value)

Sets the identification of the fuel mass getting propagated.

getDryMassIdentification

public final String getDryMassIdentification()

Gets the identification of the dry mass getting propagated.

setDryMassIdentification

public final void setDryMassIdentification(String value)

Sets the identification of the dry mass getting propagated.

getExhaustVelocity

public final Scalar getExhaustVelocity()

Gets the exhaust velocity in meters per second. If you have the specific impulse of your engine, you can compute the exhaust velocity by multiplying it by Earth's surface gravity, generally Constants.EarthSurfaceGravity.

setExhaustVelocity

public final void setExhaustVelocity(Scalar value)

Sets the exhaust velocity in meters per second. If you have the specific impulse of your engine, you can compute the exhaust velocity by multiplying it by Earth's surface gravity, generally Constants.EarthSurfaceGravity.

getInvalidFuelUseBehavior

@Nonnull
public final InvalidFuelStateBehavior getInvalidFuelUseBehavior()

Gets a enum specifying what should be done if there is not enough fuel for the requested DeltaV (get / set).

setInvalidFuelUseBehavior

public final void setInvalidFuelUseBehavior(@Nonnull
                                            InvalidFuelStateBehavior value)

Sets a enum specifying what should be done if there is not enough fuel for the requested DeltaV (get / set).